Regenerate webhook secret

POST

api

webhooks

{id}

regenerate_secret

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

X-Auth-Token

string

header

required

API token generated at Settings > API

integer

required

200 - application/json

New secret generated (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>"
}

Documentation Index