---
title: "Get webhook configuration"
method: GET
path: "/v1/account/settings/webhook_details"
tags: ["Webhooks"]
---

# Get webhook configuration

`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`

Retrieve your most recent webhook configuration.

---

Returns the same object as that of the most recent [webhook registration](ref:configure-webhook).

You can find a list of supported account-level event types and their sample notifications in the [Account-level webhook guide](doc:account-level-webhook#available-events).

> 🚧 We have a better version!
> This product is superseded by [Org Level Webhooks](doc:organization-level-webhook), which we recommend for improved functionality and integration.

## Response `200`

Success

- object
  - `status` integer, required: Numerical code indicating the status of this request. Will be 200 for a successful response.
  - `code` integer: Numerical code indicating the nature of an error. Will not be present if the response is successful.
  - `message` string, required: A textual description that indicates details about this response's status. Will be "OK" for a successful request.
  - `response` WebhookRegistration, required: An object that describes the active webhook registration. Only one webhook can be registered at this time; if you need multiple event handlers, your implementation should inspect the request payload and direct events as needed.
    - `webhook_endpoint` string, url, required: The value of `webhook_endpoint` that was provided in the request. Can contain query parameters, port numbers, authentication credentials, and other URL components.
    - `events` WebhookEventType[], required: The webhook events that were successfully registered. Invalid event names will not be included here.

---

[API](https://skmtc.dev/ocrolus/apis/account-level-webhooks.md) - [All operations](https://skmtc.dev/ocrolus/apis/account-level-webhooks/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/account-level-webhooks/revisions/aafc604fdd8a?raw)