---
title: "List Webhooks"
method: GET
path: "/webhooks"
tags: ["Webhooks"]
---

# List Webhooks

`GET /webhooks`

Plug can send webhook events for any notable events for recurring requests. For example, this could include if a new statement is available or we notice a credential is now resulting in login failure. This endpoint allows you to get a list of all the webhooks that are in the system. However, the system will not create any webhooks until your organization has configured a webhook URL. You can configure this in Dashboard by selecting the gear in the top right corner to open the Configuration list, then select Webhooks.  This endpoint is pageable.

Webhooks are deleted automatically after 30 days past their last send attempt date, except for Realtime Credential Validation (RTCV) webhooks or MFA-related webhooks, which are deleted immediately after successfully being delivered or after 3 failed send attempts. RTCV webhooks have `eventType` of either `REAL_TIME_CREDENTIAL_VALIDATION_SUCCESS` or `REAL_TIME_CREDENTIAL_VALIDATION_FAILURE` and may have a webhook URL different from the organization default if the credential was submitted via Connect. MFA webhooks have `eventType` of either `MFA_CHALLENGE_METHOD` or `MFA_CHALLENGE_CODE`.

Note that the webhook resources returned by this endpoint are not the same as the payload that is sent to the webhook URL. That payload is included in the message field as a JSON string in this resource which also includes more metadata about the webhook, such as the last and next send attempt times.

For more information on how webhooks work in Plug, see [this page](https://docs.arcadia.com/reference/webhooks-overview).

This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing).

## Query parameters

- `search` string
- `page` integer
- `size` integer
- `sort` string[]

## Headers

- `Arcadia-Version` string, required

## Response `200`

OK

- PagedPublicWebhookResource
  - `page` PageMetadata, required — Specifies which page of results to return; this is 0-indexed
    - `number` integer, required
    - `size` integer, required
    - `totalElements` integer, required
    - `totalPages` integer, required
  - `webhooks` PublicWebhookResource[], required — An array of webhook objects.
    - `createdAt` string, date-time, nullable, required — A timestamp indicating when the entity was created.
    - `eventType` 'STATUS_CHANGE' | 'MFA_CHALLENGE_METHOD' | 'MFA_CHALLENGE_CODE' | 'EXISTING_DATA_UPDATED' | 'NEW_DATA_AVAILABLE' | 'REAL_TIME_CREDENTIAL_VALIDATION_SUCCESS' | 'REAL_TIME_CREDENTIAL_VALIDATION_FAILURE' | 'BUSINESS_UNIT_ASSIGNMENT', nullable, required — The type of webhook. This field indicates the reason the webhook was emitted.
    - `id` string, required — A unique identifier for the entity.
    - `lastAttemptedSendAt` string, date-time, nullable, required — The timestamp indicating when we last attempted to send this webhook to you.
    - `lastSendHttpStatus` integer, nullable, required — The HTTP status code received for the most recent attempt to send this webhook.
    - `message` string, required — The body payload of the webhook as a JSON string.
    - `nextScheduledSendAt` string, date-time, nullable, required — The scheduled time for the next webhook to be sent.
    - `numberOfAttempts` integer, required — The number of attempts we have made to send this webhook.
    - `resource` 'STATEMENT' | 'ACCOUNT' | 'CREDENTIAL' | 'DELETION' | 'FILE' | 'MFA_METHOD_PROMPT' | 'MFA_CODE_PROMPT' | 'DOWNLOAD' | 'ROOT_BUSINESS_UNIT_ACCOUNT', nullable, required — The resource type of the entity that the webhook references. This field determines the structure of the payload contained in the data field of the webhook body.
    - `status` 'WAITING_RESEND' | 'FAILURE' | 'SUCCESS', required — Status of the resource.
    - `webhookUrl` string, required — The URL in Live mode used for you to receive webhook notifications or callbacks.

---

[API](https://skmtc.net/arcadia/apis/plug-api.md) · [All operations](https://skmtc.net/arcadia/apis/plug-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arcadia/plug-api/revisions/d00587742116/schema)