v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Webhooks

Configure webhook

Set up a webhook for your account so your application can react to Ocrolus events.


You can find a list of supported account-level event types and their sample notifications in the Account-level webhook guide.

📘 Your webhook integration should respond to incoming notifications with a status of 200 OK to indicate that it's working properly.

🚧 We have a better version! This product is superseded by Org Level Webhooks, which we recommend for improved functionality and integration.

post/v1/account/settings/update/webhook_endpoint

Response

Success

statusinteger required

Numerical code indicating the status of this request. Will be 200 for a successful response.

codeinteger

Numerical code indicating the nature of an error. Will not be present if the response is successful.

messagestring required

A textual description that indicates details about this response's status. Will be "OK" for a successful request.