Skip to main content
POST
/
v1
/
webhooks
/
{webhookId}
/
simulate
Simulate webhook event
curl --request POST \
  --url https://api-staging.respondent.io/v1/webhooks/{webhookId}/simulate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "event": "PROJECTS.UPDATED",
  "screenerResponseUpdatedType": "STATUS.PAID"
}
'

Documentation Index

Fetch the complete documentation index at: https://developers.respondent.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

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

Path Parameters

​
webhookId
string
required

Body

application/json
​
event
enum<string>
required

The webhook event type to simulate.

Available options:
PROJECTS.UPDATED,
SCREENER_RESPONSES.CREATED,
SCREENER_RESPONSES.UPDATED,
MESSAGES.CREATED,
CONVERSATIONS.CREATED
​
screenerResponseUpdatedType
enum<string>

The status or rejection of the screener to test. Only used for SCREENER_RESPONSES.UPDATED events.

Available options:
STATUS.PAID,
STATUS.CANCELLED,
REJECTED.TRUE,
REJECTED.FALSE

Response

201 - undefined