API v2 Documentation (Beta)
Client API - Response
Client API - Contacts
Client API - Display
Client API - Environment
Client API - User
Client API - File Upload
Roles
Me
Management API - Responses
Management API - Contacts
Management API - Contact Attribute Keys
Management API - Surveys - Contact Links
Management API - Webhooks
Organizations API - Teams
Organizations API - Project Teams
Organizations API - Users
Management API - Webhooks
Create a webhook
Creates a webhook in the database.
POST
/
webhooks
Copy
Ask AI
curl --request POST \
--url https://app.formbricks.com/api/v2/management/webhooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "<string>",
"url": "<string>",
"source": "user",
"environmentId": "<string>",
"triggers": [
"responseFinished"
],
"surveyIds": [
"<string>"
]
}'
Copy
Ask AI
{
"id": "<string>",
"name": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"url": "<string>",
"source": "user",
"environmentId": "<string>",
"triggers": [
"responseFinished"
],
"surveyIds": [
"<string>"
]
}
Authorizations
Use your Formbricks x-api-key to authenticate.
Body
application/json
The webhook to create
The body is of type object
.
Response
201 - application/json
Webhook created successfully.
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request POST \
--url https://app.formbricks.com/api/v2/management/webhooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "<string>",
"url": "<string>",
"source": "user",
"environmentId": "<string>",
"triggers": [
"responseFinished"
],
"surveyIds": [
"<string>"
]
}'
Copy
Ask AI
{
"id": "<string>",
"name": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"url": "<string>",
"source": "user",
"environmentId": "<string>",
"triggers": [
"responseFinished"
],
"surveyIds": [
"<string>"
]
}
Assistant
Responses are generated using AI and may contain mistakes.