Create a webhook

POST

/customers/v1/webhooks/subscriptions

Delivery is via AWS SNS HTTPS subscription: after creating the subscription your endpoint receives an SNS SubscriptionConfirmation message that must be confirmed before notifications flow.

Request

Header Params

Body Params application/json

Example

{
    "url": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/customers/v1/webhooks/subscriptions' \
--header 'x-client-id;' \
--header 'Content-Type: application/json' \
--data '{
    "url": "string"
}'

Responses

🟢201Created

application/json

Bodyapplication/json

Example

{
    "id": "530d8eae-b44c-4ae3-9c31-874bf98b2bdf",
    "owner": "a30595d9-de0a-42ae-b3f3-55643abd2eb8",
    "url": "https://male-goat.biz?client-id=a30595d9-de0a-42ae-b3f3-55643abd2eb8",
    "created_at": "2025-01-14T17:00:33.406Z",
    "updated_at": "2025-01-14T17:00:33.410Z",
    "metadata": {
        "subscription_arn": "arn:aws:sns:ap-southeast-2:123456789012:webhooks-topic:530d8eae-b44c-4ae3-9c31-874bf98b2bdf"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2026-08-05 04:06:25

Get all webhooks

Delete a webhook