Webhooks

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

post/webhook-endpoints

Request

  • Base URL: https://api.eu.doconda.com/v1
  • URL: https://api.eu.doconda.com/v1/webhook-endpoints
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

urlstring uri required

HTTPS, on a public address.

event_typesstring[]

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

Response

Created; secret is returned only once.

idstring required
urlstring required
event_typesstring[] required
created_atstring date-time required
secretstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.