---
title: "List Webhook Events"
method: GET
path: "/v1/webhooks/events"
tags: ["Webhook Events"]
---

# List Webhook Events

`GET /v1/webhooks/events`

Returns a list of existing Webhook Events.

## Query parameters

- `page` integer
- `page_size` integer
- `created_at.gte` string
- `created_at.lte` string
- `status` WebhooksWebhookEventStatus[]
- `type` 'company' | 'item' | 'payable' | 'payment_method' | 'receivable' | 'risk_report' | 'tax_form' | 'test' — All the possible WebhookEvent types for the `/v1/webhooks/events` endpoint.

## Response `200`

OK

- WebhooksWebhookEventList
  - `object` 'List', required — The object’s type (`List`).
  - `links` SharedListLinks, required — Related links.
    - `self` string, uri-reference, required — Link to this object.
    - `next` string, uri, nullable — Link to the next page of results.
    - `prev` string, uri, nullable — Link to the previous page of results.
  - `results` WebhooksWebhookEvent[], required
    - `object` 'WebhookEvent', required — The object’s type (`WebhookEvent`).
    - `id` string, uuid, required — The Webhook Event ID.
    - `created_at` string, date-time, required — The last date this Webhook Event was tried to be sent.
    - `detail` object
      - `company_id` string, uuid — The identifier of the Company to which the resource that triggered the webhook belongs.
      - `errors` object, nullable — A list of any errors that may have occurred on the action that triggered the webhook.
      - `external_id` string, nullable — The external identifier of the resource that fired the webhook.
      - `idempotency_key` string, nullable — The idempotency key of the request that fired the webhook, if applicable.
      - `request_id` string, uuid, nullable — The request identifier for the request that fired the webhook, if applicable.
    - `event_name` string, required — The event name of this Webhook Event.
    - `event_resource` 'company' | 'item' | 'payable' | 'payment_method' | 'receivable' | 'risk_report' | 'tax_form' | 'test', required — All the possible WebhookEvent types for the `/v1/webhooks/events` endpoint.
    - `is_paused` boolean, required — If set to true, Routable will not try to send this Webhook Event again.
    - `is_successful` boolean, required — Whether this Webhook Event was successfully sent.
    - `last_attempt_at` string, date-time — The last date this Webhook Event was tried to be sent.
    - `last_status` integer, required — If this Webhook Event was sent, what was the HTTP Response Routable received back.
    - `next_attempt_at` string, date-time — The date this Webhook Event will be attempted to be sent again.
    - `object_id` string, required — The ID of the object associated with this Webhook Event.
    - `tries` integer, required — The number of attempts made to send this Webhook Event.
    - `links` WebhooksWebhookEventLinks, required — Related links.
      - `self` string, uri-reference, required — Link to this object.
      - `resource` string, uri, nullable, required — Link to this Webhook Event's resource.

---

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