v2.webhook_endpoints

Send a test cooud.ping event (platform key)

Platform keys only. Enqueues a synthetic cooud.ping event (data: { test: true, endpoint }, account: null) to the endpoint. It is never published to the broker and touches no order; it is signed and retried exactly like a real event, so it is the way to prove an integration end to end — including from a sandbox key.

post/webhook_endpoints/{id}/ping

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/webhook_endpoints/{id}/ping
  • Auth: HTTP bearer

Path parameters

idstring required

Webhook endpoint id (cooud_we_<ULID>).

Headers

Cooud-Compat-Datestring date required

Required per-request compat-date. Format: ISO calendar date YYYY-MM-DD. Merchants pinned to an older date have their request and response transformed by every gate whose appliesAfter is strictly greater than this date.

Response

The ping delivery was enqueued.

event_type'cooud.ping' required
idstring required
object'webhook_delivery' required
request_idstring required
status'pending' required

Changes

No recorded changes to this operation across all 1 revision of this API.