Create Webhook Subscription

Request

Body Params application/json

endpoint

string <uri>

required

Destination URI to which the webhook subscription should send the POST request when an event occurs

>= 1 characters<= 2083 characters

topics

array[string]

required

Event that triggers the webhook

Allowed values:

request.createdrequest.updatedrequest.deletedrequest.submittedrequest.verifiedrequest.rejectedrequest.opened

Example

{
    "endpoint": "http://example.com",
    "topics": [
        "request.created"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/webhooks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "endpoint": "http://example.com",
    "topics": [
        "request.created"
    ]
}'

Responses

🟢200OK

application/json

Successful Response

Body

endpoint

string <uri>

required

Destination URI to which the webhook subscription should send the POST request when an event occurs

>= 1 characters<= 2083 characters

topics

array[string]

required

Event that triggers the webhook

Allowed values:

request.createdrequest.updatedrequest.deletedrequest.submittedrequest.verifiedrequest.rejectedrequest.opened

id

string

required

Example

{
    "endpoint": "http://example.com",
    "topics": [
        "request.created"
    ],
    "id": "string"
}

🟠400Bad Request