Create webhook

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

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)

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

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

Overview

Partner API

Templates

Thumbnails

Submissions

Submitters

Users

Access Tokens

Webhooks

Settings

Custom Domains

Teams

Audit Events

MFA

BAA

Security Events

Subscriptions

Plans

Payments

Verification

KBA

AI

Embed

Health

Authorizations

Body

Response