Skip to main content

Create/Register a Webhook - APIv2

Updated

The server synchronously POSTs an activation payload { "event": "activation", "code": "<6-char>" } to the configured url using the configured authentication headers and records the outcome on the webhook

  • 2xx response → record stored with status: pending, response code: created_not_verified. The caller's endpoint received the 6-character verification code; submit it to POST /v2/webhooks/{webhookId}/activate to transition the webhook to active.
  • non-2xx / network failure → record stored with status: failed, response code: created_failed. The id is returned in the same response envelope so the caller can PATCH /v2/webhooks/{webhookId} to retry the activation handshake (PATCH always re-runs the handshake when the stored record is failed).

At most one webhook per (client, eventType) may be in active, pending, or failed state at once. pending and failed records carry a 7-day time-to-live expiry; abandoned records are reaped automatically.

Please refer to the APIv2 developer's documentation for a complete overview of the webhook registration process.

 

 

Related articles