Create a webhook

POST

https://prod.your-api-server.com/webhooks

Last modified:2026-04-29 08:09:11

Creates a webhook subscription. The response includes the signing
secret used to verify incoming deliveries — capture it now; we do
not return it again.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "url": "string",
    "eventTypes": [
        "string"
    ],
    "description": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://prod.your-api-server.com/webhooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "string",
    "eventTypes": [
        "string"
    ],
    "description": "string"
}'

Responses

🟢201

application/json

Created

Body

Example

{
    "subscription": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "url": "string",
        "eventTypes": [
            "string"
        ],
        "description": "string",
        "isActive": true,
        "disabledForFailures": true,
        "consecutiveFailures": 0,
        "lastDeliveryAt": "2019-08-24T14:15:22.123Z",
        "createdAt": "2019-08-24T14:15:22.123Z"
    },
    "signingSecret": "string"
}

🟠400

🟠401

🟠409

🟠429

🔴500

Modified at 2026-04-29 08:09:11

List webhooks

Update a webhook