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>"
}
'
{
  "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>