v1

latestOpenAPI 3.0.02026-07-2447166133.5 KB

Webhooks

Create a webhook destination endpoint

This operation creates a destination endpoint for webhooks events.

post/webhooks/endpoints

Headers

s-idempotency-keystring

A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long.

Request body

namestring required

The name of the webhook destination endpoint

urlstring url required

The URL of the webhook destination endpoint

Example request

{
  "name": "My Webhook Endpoint",
  "url": "https://example.com/webhook"
}

Response

The newly created webhook destination endpoint

Example response

{
  "endpoint": {
    "createdAt": "2020-04-01T00:00:00Z",
    "id": "wde_01HWDG5ADNBGJ3XXXXXFP8P1GH",
    "name": "My Webhook Endpoint",
    "signingSecrets": [
      {
        "id": "wss_01HWDG5ADNBGXXXXXY07DP8"
      }
    ],
    "url": "https://example.com/webhook"
  }
}