Update a webhook

Updates a webhook in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.

PUT /management/webhooks/{id}

Update a webhook

cURL

curl --request PUT \
  --url https://app.formbricks.com/api/v2/management/webhooks/{id} \
  --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/{id}"

payload = {
    "name": "<string>",
    "url": "<string>",
    "workspaceId": "<string>",
    "triggers": [],
    "surveyIds": ["<string>"],
    "environmentId": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  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/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  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/{id}"

	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("PUT", 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.put("https://app.formbricks.com/api/v2/management/webhooks/{id}")
  .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/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.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

200

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "url": "<string>",
  "workspaceId": "<string>",
  "environmentId": "<string>",
  "triggers": [],
  "surveyIds": [
    "<string>"
  ]
}

Authorizations

x-api-key · string · header · required

Use your Formbricks x-api-key to authenticate.

Path Parameters

id · string · required

The ID of the webhook

Body

application/json

The webhook to update

name · string | null · required

The name of the webhook

url · string<uri> · required

The URL of the webhook

source · enum<string> · required

The source of the webhook

Available options: user, zapier, make, n8n

workspaceId · string · required

The ID of the Workspace

triggers · enum<string>[] · required

The triggers of the webhook

Minimum array length: 1

Available options: responseFinished, responseCreated, responseUpdated

surveyIds · string[] · required

The IDs of the surveys

environmentId · string · deprecated

Deprecated alias for workspaceId.

Response

200 - application/json

Webhook updated successfully.

id · string

The ID of the webhook

name · string | null

The name of the webhook

createdAt · string

The date and time the webhook was created

Example:

"2021-01-01T00:00:00.000Z"

updatedAt · string

The date and time the webhook was last updated

Example:

"2021-01-01T00:00:00.000Z"

url · string<uri>

The URL of the webhook

source · enum<string>

The source of the webhook

Available options: user, zapier, make, n8n

workspaceId · string

The ID of the Workspace

environmentId · string · deprecated

Deprecated alias for workspaceId.

triggers · enum<string>[]

The triggers of the webhook

Minimum array length: 1

Available options: responseFinished, responseCreated, responseUpdated

surveyIds · string[]

The IDs of the surveys