Create webhook endpoint

POST

/webhooks

Maintainer:Not configured

Create a new webhook endpoint. The response includes the signing secret which is only shown once at creation — store it securely for verifying webhook signatures.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Example

{
    "url": "https://your-app.com/webhooks/references",
    "events": [
        "reference.submitted",
        "reference.declined",
        "reference.all_completed"
    ],
    "timeout_seconds": 30,
    "max_retries": 3
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/webhooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://your-app.com/webhooks/references",
    "events": [
        "reference.submitted",
        "reference.declined",
        "reference.all_completed"
    ],
    "timeout_seconds": 30,
    "max_retries": 3
}'

Responses

🟢201

application/json

Endpoint created

Bodyapplication/json

Example

{
    "data": {
        "id": 15,
        "name": "Primary CRM",
        "url": "http://example.com",
        "events": [
            "worker.status_changed"
        ],
        "is_active": true,
        "timeout_seconds": 0,
        "secret_prefix": "string",
        "last_delivered_at": "2019-08-24T14:15:22.123Z",
        "last_response_code": 0,
        "consecutive_failures": 0,
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    },
    "secret": "string",
    "message": "string"
}

Modified at 2026-02-17 18:56:15

List webhook endpoints

Update webhook endpoint