Webhooks

Get webhook configuration

Retrieve your most recent webhook configuration.


Returns the same object as that of the most recent webhook registration.

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

🚧 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/webhook_details

Request

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

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.

Changes

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