Create a webhook
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>",
"workspaceId": "<string>",
"triggers": [],
"surveyIds": [
"<string>"
],
"environmentId": "<string>"
}
'import requests
url = "https://app.formbricks.com/api/v2/management/webhooks"
payload = {
"name": "<string>",
"url": "<string>",
"workspaceId": "<string>",
"triggers": [],
"surveyIds": ["<string>"],
"environmentId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
workspaceId: '<string>',
triggers: [],
surveyIds: ['<string>'],
environmentId: '<string>'
})
};
fetch('https://app.formbricks.com/api/v2/management/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.formbricks.com/api/v2/management/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'workspaceId' => '<string>',
'triggers' => [
],
'surveyIds' => [
'<string>'
],
'environmentId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.formbricks.com/api/v2/management/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"triggers\": [],\n \"surveyIds\": [\n \"<string>\"\n ],\n \"environmentId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.formbricks.com/api/v2/management/webhooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"triggers\": [],\n \"surveyIds\": [\n \"<string>\"\n ],\n \"environmentId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"triggers\": [],\n \"surveyIds\": [\n \"<string>\"\n ],\n \"environmentId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"url": "<string>",
"source": "user",
"workspaceId": "<string>",
"environmentId": "<string>",
"triggers": [
"responseFinished"
],
"surveyIds": [
"<string>"
]
}Management API - Webhooks
Create a webhook
Creates a webhook in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
POST
/
management
/
webhooks
Create a webhook
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>",
"workspaceId": "<string>",
"triggers": [],
"surveyIds": [
"<string>"
],
"environmentId": "<string>"
}
'import requests
url = "https://app.formbricks.com/api/v2/management/webhooks"
payload = {
"name": "<string>",
"url": "<string>",
"workspaceId": "<string>",
"triggers": [],
"surveyIds": ["<string>"],
"environmentId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
workspaceId: '<string>',
triggers: [],
surveyIds: ['<string>'],
environmentId: '<string>'
})
};
fetch('https://app.formbricks.com/api/v2/management/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.formbricks.com/api/v2/management/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'url' => '<string>',
'workspaceId' => '<string>',
'triggers' => [
],
'surveyIds' => [
'<string>'
],
'environmentId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.formbricks.com/api/v2/management/webhooks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"triggers\": [],\n \"surveyIds\": [\n \"<string>\"\n ],\n \"environmentId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.formbricks.com/api/v2/management/webhooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"triggers\": [],\n \"surveyIds\": [\n \"<string>\"\n ],\n \"environmentId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"triggers\": [],\n \"surveyIds\": [\n \"<string>\"\n ],\n \"environmentId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"url": "<string>",
"source": "user",
"workspaceId": "<string>",
"environmentId": "<string>",
"triggers": [
"responseFinished"
],
"surveyIds": [
"<string>"
]
}Authorizations
Use your Formbricks x-api-key to authenticate.
Body
application/json
The webhook to create
The name of the webhook
The URL of the webhook
The source of the webhook
Available options:
user, zapier, make, n8n The ID of the Workspace
The triggers of the webhook
Minimum array length:
1Available options:
responseFinished, responseCreated, responseUpdated The IDs of the surveys
Deprecated alias for workspaceId.
Response
201 - application/json
Webhook created successfully.
The ID of the webhook
The name of the webhook
The date and time the webhook was created
Example:
"2021-01-01T00:00:00.000Z"
The date and time the webhook was last updated
Example:
"2021-01-01T00:00:00.000Z"
The URL of the webhook
The source of the webhook
Available options:
user, zapier, make, n8n The ID of the Workspace
Deprecated alias for workspaceId.
The triggers of the webhook
Minimum array length:
1Available options:
responseFinished, responseCreated, responseUpdated The IDs of the surveys
Was this page helpful?