Skip to main content
POST
/
api
/
v1
/
webhooks
Create Webhook
curl --request POST \
  --url https://{baseurl}/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "triggers": [
    "responseCreated",
    "responseUpdated",
    "responseFinished"
  ],
  "url": "https://eoy8o887lmsqmhz.m.pipedream.net"
}'
{
  "data": {
    "createdAt": "2024-04-23T12:35:45.326Z",
    "environmentId": "clurwouax000azffxt7n5unn3",
    "id": "clvcdd8oe000nxz1zhz6q9z3l",
    "name": null,
    "source": "user",
    "surveyIds": [],
    "triggers": [
      "responseCreated",
      "responseUpdated",
      "responseFinished"
    ],
    "updatedAt": "2024-04-23T12:35:45.326Z",
    "url": "https://eoy8o887lmsqmhz.m.pipedream.net"
  }
}

Headers

​
x-api-key
string
required

Body

application/json
​
triggers
enum<string>[]
required

List of events that trigger this webhook

​
url
string
required

The webhook URL to call when triggers are fired

​
name
string

Optional name for the webhook

​
surveyIds
string[]

Optional list of survey IDs to filter webhook calls

Response

200 - application/json

OK

The response is of type object.