Skip to main content
POST
Create a webhook

Authorizations

X-API-Key
string
header
required

A scoped key with the of_live_ prefix, generated from Profile > API keys.

Body

application/json
form_id
string
required
Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439011"

url
string<uri>
required
enabled
boolean
default:true
signing_secret
string
write-only
Minimum string length: 16

Response

Webhook created.

id
string
required
Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439011"

form_id
string
required
Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439011"

url
string<uri>
required
enabled
boolean
required
event_types
string[]
required
Allowed value: "form.response.completed"
has_secret
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required