Create webhook subscription

POST

/webhook-subscriptions

Request

Body Params application/json

Example

{
    "name": "My Subscription",
    "url": "https://example.com",
    "triggers": [
        "recipient_completed"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/webhook-subscriptions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Subscription",
    "url": "https://example.com",
    "triggers": [
        "recipient_completed"
    ]
}'

Responses

🟢201Created

application/json

Webhook subscription created

Body

Example

{
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "My Subscription",
    "url": "https://example.com",
    "active": true,
    "triggers": [
        "recipient_completed"
    ],
    "workspace_id": "Nq8htXxFssmhRxAPSP4SBP",
    "shared_key": "587c22285F57883db3ee",
    "status": "ACTIVE"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429429

Modified at 2024-09-17 17:05:10

Get all webhook subscriptions

Get webhook subscription by uuid