---
title: "Test webhook"
method: GET
path: "/v1/account/settings/test_webhook_endpoint"
tags: ["Webhooks"]
---

# Test webhook

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

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:

```json
{
  "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](doc:organization-level-webhook), which we recommend for improved functionality and integration.

## Response `200`

The configured webhook returned successfully.

- 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` object, required
    - `resp_code` integer: The status code that your webhook returned.
    - `message` string, required: Details about the response that your webhook returned. If the response wasn't a success, this attribute will contain the reason.

---

[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)