Sign in
Webhook Endpoints

Register Webhook

post/v1/instances/{instance_id}/webhook-endpoints

Path parameters

instance_idstring required
Example:in_000000000000

Headers

Idempotency-Keystring

Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

urlstring uri required
eventsstring[] required

Example request

{
  "url": "https://example.com/webhook",
  "events": [
    "customer.new"
  ]
}

Response

Create webhook endpoint

idstring required

Example response

{
  "id": "we_000000000000"
}

Changes

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