v2.webhook_endpoints

Retrieve a webhook endpoint (platform key)

Platform keys only. Retrieves one endpoint; an endpoint of another platform is 404.

get/webhook_endpoints/{id}

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/webhook_endpoints/{id}
  • 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 endpoint, without its secret.

createdinteger required

Unix epoch seconds.

descriptionstring nullable required
enabled_eventsstring[] required
idstring required
livemodeboolean required

true when the endpoint was created with a live platform key. Real events (cooud.order.*, cooud.account.updated) are only delivered to live endpoints; sandbox endpoints receive cooud.ping and the simulated cooud.order.paid (livemode: false, data.id ord_sim_…, data.checkout_session_id) of the sandbox checkout sessions the platform confirms — never a real order.

object'webhook_endpoint' required
request_idstring required
status'active' | 'disabled' required
urlstring required

Changes

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