Skip to main content
WEBHOOK
Webhooks fire when an EntityLocker session moves from created to succeeded or failed, so you don’t need to poll the session status. The webhook’s data contains the session, with the same schema as data in the session status response. After succeeded, read data.documents_consented and fetch each document. A session failed when the user denies consent or the authorization can’t be completed. Configure the webhook before initiating sessions. See the webhooks guide to set your URL and validate x-sandbox-signature.

Body

application/json

EntityLocker session status notification.

data
object
required

Session details use the same schema as data in the EntityLocker session status response.

Response

200

Return a 2xx status to acknowledge receipt of the notification.