Skip to main content
POST
/
v1
/
webhooks
Create webhook
curl --request POST \
  --url https://api-staging.respondent.io/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "url": "<string>",
  "teamId": "<string>"
}
'
{
  "id": "<string>",
  "url": "<string>",
  "privateKey": "<string>",
  "teamId": "<string>",
  "organizationId": "<string>"
}

​
Webhook behavior

Retry policy

Failed deliveries are retried up to 5 times at 10-minute intervals. Your endpoint must respond within 3 seconds.

Event types

Use Retrieve Event Types to see all available events, then Simulate to test your handler.

Headers

​
x-api-key
string
required
​
x-api-secret
string
required

Body

application/json
​
url
string
required

The URL to send the webhook payload to.

​
teamId
string<ObjectId>

The teamId to which the webhook belongs.

Response

201 - application/json
​
id
string<ObjectId>
required
​
url
string
required

The URL to send the webhook payload to.

​
privateKey
string
required

The secret key to be used to sign the webhook payload.

​
teamId
string<ObjectId>
​
organizationId
string<ObjectId>