Saltar al contenido principal
POST
Registrar un endpoint de webhook: le enviamos un evento firmado por POST cuando termina un documento

Autorizaciones

Authorization
string
header
requerido

Authorization: Bearer ak_eu_…, con una key del panel (API keys).

Cuerpo

application/json
url
string<uri>
requerido

HTTPS, en una dirección pública.

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

Si no lo pones, todos: document.ready, document.failed, document.canceled, document.updated y document.update_failed.

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

Respuesta

Creado; secret se devuelve solo esta vez.

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,
document.updated,
document.update_failed
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_…, para comprobar la firma de lo que enviamos. Solo se muestra ahora: guárdalo en un lugar seguro.