Skip to main content
POST
/
api
/
v1
/
webhooks
Create Webhook
curl --request POST \
  --url 'http://{{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"
}
'
import requests

url = "http://{{baseurl}}/api/v1/webhooks"

payload = {
"triggers": ["responseCreated", "responseUpdated", "responseFinished"],
"url": "https://eoy8o887lmsqmhz.m.pipedream.net"
}
headers = {
"x-api-key": "<x-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': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
triggers: ['responseCreated', 'responseUpdated', 'responseFinished'],
url: 'https://eoy8o887lmsqmhz.m.pipedream.net'
})
};

fetch('http://{{baseurl}}/api/v1/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 => "http://{{baseurl}}/api/v1/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([
'triggers' => [
'responseCreated',
'responseUpdated',
'responseFinished'
],
'url' => 'https://eoy8o887lmsqmhz.m.pipedream.net'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-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 := "http://{{baseurl}}/api/v1/webhooks"

payload := strings.NewReader("{\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<x-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("http://{{baseurl}}/api/v1/webhooks")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://{{baseurl}}/api/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"triggers\": [\n \"responseCreated\",\n \"responseUpdated\",\n \"responseFinished\"\n ],\n \"url\": \"https://eoy8o887lmsqmhz.m.pipedream.net\"\n}"

response = http.request(request)
puts response.read_body
{
  "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

The body is of type object.

Response

200 - application/json

OK

The response is of type object.