Skip to main content
POST
/
api
/
webhooks
Error
A valid request URL is required to generate request examples
{
  "id": 123,
  "url": "<string>",
  "events": [],
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "secret_key": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spitshake.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Auth-Token
string
header
required

API token generated at Settings > API

Body

application/json
url
string<uri>
required

HTTPS endpoint URL

events
enum<string>[]

Events to subscribe to (empty = all events)

Available options:
template.created,
template.updated,
template.archived,
submission.created,
submission.completed,
submission.archived,
form.created,
form.started,
form.completed,
form.declined,
signing.complete
enabled
boolean
default:true

Response

Webhook created (includes secret_key)

id
integer
url
string<uri>
events
enum<string>[]
Available options:
template.created,
template.updated,
template.archived,
submission.created,
submission.completed,
submission.archived,
form.created,
form.started,
form.completed,
form.declined,
signing.complete
enabled
boolean
created_at
string<date-time>
secret_key
string

Only returned on create or regenerate