Skip to main content
POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.tally.so/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formId": "<string>",
  "url": "<string>",
  "eventTypes": [
    "FORM_RESPONSE"
  ],
  "signingSecret": "<string>",
  "httpHeaders": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "externalSubscriber": "<string>"
}
'
import requests

url = "https://api.tally.so/webhooks"

payload = {
"formId": "<string>",
"url": "<string>",
"eventTypes": ["FORM_RESPONSE"],
"signingSecret": "<string>",
"httpHeaders": [
{
"name": "<string>",
"value": "<string>"
}
],
"externalSubscriber": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
formId: '<string>',
url: '<string>',
eventTypes: ['FORM_RESPONSE'],
signingSecret: '<string>',
httpHeaders: [{name: '<string>', value: '<string>'}],
externalSubscriber: '<string>'
})
};

fetch('https://api.tally.so/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://api.tally.so/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([
'formId' => '<string>',
'url' => '<string>',
'eventTypes' => [
'FORM_RESPONSE'
],
'signingSecret' => '<string>',
'httpHeaders' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'externalSubscriber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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://api.tally.so/webhooks"

payload := strings.NewReader("{\n \"formId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventTypes\": [\n \"FORM_RESPONSE\"\n ],\n \"signingSecret\": \"<string>\",\n \"httpHeaders\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"externalSubscriber\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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://api.tally.so/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"formId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventTypes\": [\n \"FORM_RESPONSE\"\n ],\n \"signingSecret\": \"<string>\",\n \"httpHeaders\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"externalSubscriber\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.tally.so/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"formId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventTypes\": [\n \"FORM_RESPONSE\"\n ],\n \"signingSecret\": \"<string>\",\n \"httpHeaders\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"externalSubscriber\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "url": "<string>",
  "eventTypes": [
    "FORM_RESPONSE"
  ],
  "isEnabled": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
formId
string
required

The ID of the form to create the webhook for

url
string
required

The URL to send webhook events to

eventTypes
enum<string>[]
required

Types of events to receive

Available options:
FORM_RESPONSE
signingSecret
string | null

Optional secret used to sign webhook payloads

httpHeaders
object[] | null

Optional custom HTTP headers to include in webhook requests

externalSubscriber
string

Optional identifier for the external subscriber

Response

Webhook created successfully

id
string
url
string
eventTypes
enum<string>[]
Available options:
FORM_RESPONSE
isEnabled
boolean
createdAt
string<date-time>