OCocrolus
Webhooks

Test webhook

Send a test payload to your configured webhook endpoint.

Requests to this endpoint will send a POST request with a test payload of the following JSON in the request body:

{
  "status": "VERIFICATION_COMPLETE",
  "uploaded_doc_pk": 0,
  "book_pk": 0
}

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

If the webhook fails for any reason, the corresponding HTTP status code and message will be provided in the response's message and code attributes.

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

get/v1/account/settings/test_webhook_endpoint

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/account/settings/test_webhook_endpoint
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Response

The configured webhook returned successfully.

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.

Changes

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