Skip to main content
POST
Register a webhook endpoint: we POST a signed event to it when a document finishes

Autorizaciones

Authorization
string
header
requerido

Authorization: Bearer ak_eu_…. The prefix is the project's region and must match the server (api.eu / api.us).

Cuerpo

application/json
url
string<uri>
requerido

HTTPS, on a public address.

Maximum string length: 2048
event_types
enum<string>[]

Without it, all: document.ready, document.failed and document.canceled.

Minimum array length: 1
Opciones disponibles:
document.ready,
document.failed,
document.canceled

Respuesta

Created; secret is returned only once.

id
string
requerido
Pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$
url
string
requerido
event_types
enum<string>[]
requerido
Opciones disponibles:
document.ready,
document.failed,
document.canceled
created_at
string<date-time>
requerido
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
secret
string
requerido

whsec_…, to check the signature of what we send. Shown only now: keep it safe.