Get a webhook

Gets a webhook from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.

GET /management/webhooks/{id}

Get a webhook

cURL

curl --request GET \
  --url https://app.formbricks.com/api/v2/management/webhooks/{id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://app.formbricks.com/api/v2/management/webhooks/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://app.formbricks.com/api/v2/management/webhooks/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.formbricks.com/api/v2/management/webhooks/{id}")
  .header("x-api-key", "<api-key>")
  .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::Get.new(url)
request["x-api-key"] = '<api-key>'

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

Response

200 - application/json

Webhook retrieved 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