Skip to main content
POST
Send a sample webhook delivery

Authorizations

X-Auth-Token
string
header
required

API token generated at Settings > API

Path Parameters

id
integer
required

Body

application/json
event
enum<string>

Event to send a sample of. Defaults to the first event the endpoint subscribes to, or form.completed when it subscribes to all.

Available options:
form.created,
form.started,
form.viewed,
form.completed,
form.declined,
form.expired,
signing.complete,
form.delegated,
field.updated,
submission.created,
submission.completed,
submission.archived,
submission.expired,
template.created,
template.updated,
template.archived
Example:

"form.completed"

Response

Sample delivered (the endpoint answered 2xx)

success
boolean
event
string

The event a sample was sent for.

Example:

"form.completed"

message
string
Example:

"Sample form.completed payload sent"

delivery_id
integer

The delivery-log entry for this send (flagged test true).

Example:

1871

delivery_uuid
string
Example:

"0a1b2c3d-4e5f-6789-0a1b-2c3d4e5f6789"