> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Webhook Deliveries
> ### Intent
Reads the available webhook deliveries as a pageable collection without changing them.
### When to call it
Call this when an interface, sync, or support workflow needs to inspect webhook deliveries. Use the filters and paging controls shown below to limit the result.
### Access boundary
Authorize the request with a token that carries `webhooks:read` or `webhooks:write`.
### Successful result
A successful request returns `200`. The response schema below defines the body your integration receives.
### Operational notes
List webhook deliveries.
Deliveries are all the attempts to deliver a webhook event to an endpoint.
**Scopes**: `webhooks:read` `webhooks:write`
export const RubaSocials = () => {
if (typeof document === "undefined") {
return null;
}
const inject = () => {
const footer = document.getElementById("footer");
if (!footer || document.getElementById("ruba-socials")) {
return false;
}
const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
const lineColor = isDark ? "#383838" : "#e8e8ed";
const iconColor = isDark ? "#8e8e93" : "#86868b";
const markColor = isDark ? "#ffffff" : "#08080c";
const hoverColor = "#0071e3";
const div = document.createElement("div");
div.id = "ruba-socials";
div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
const logo = `Ruba`;
const spacer = ``;
const ig = ``;
const li = ``;
const github = ``;
div.innerHTML = logo + spacer + ig + li + github;
footer.appendChild(div);
return true;
};
if (!document.documentElement.dataset.rubaSocialsObserver) {
document.documentElement.dataset.rubaSocialsObserver = "true";
const observer = new MutationObserver(() => {
if (!document.getElementById("ruba-socials")) {
inject();
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
}
setTimeout(() => {
if (!inject()) {
const interval = setInterval(() => {
if (inject()) {
clearInterval(interval);
}
}, 500);
setTimeout(() => clearInterval(interval), 10000);
}
}, 300);
return null;
};
## OpenAPI
````yaml get /v1/webhooks/deliveries
openapi: 3.1.0
info:
title: Ruba API
summary: Ruba HTTP and Webhooks API
description: Read the docs at https://docs.getruba.com/api-reference
version: 2026-04
servers:
- url: https://api.getruba.com
description: Production environment
x-speakeasy-server-id: production
- url: https://sandbox-api.getruba.com
description: Sandbox environment
x-speakeasy-server-id: sandbox
security: []
tags:
- name: public
description: >-
Endpoints shown and documented in the Ruba API documentation and available
in our SDKs.
paths:
/v1/webhooks/deliveries:
get:
tags:
- webhooks
- public
summary: List Webhook Deliveries
description: >-
### Intent
Reads the available webhook deliveries as a pageable collection without
changing them.
### When to call it
Call this when an interface, sync, or support workflow needs to inspect
webhook deliveries. Use the filters and paging controls shown below to
limit the result.
### Access boundary
Authorize the request with a token that carries `webhooks:read` or
`webhooks:write`.
### Successful result
A successful request returns `200`. The response schema below defines
the body your integration receives.
### Operational notes
List webhook deliveries.
Deliveries are all the attempts to deliver a webhook event to an
endpoint.
**Scopes**: `webhooks:read` `webhooks:write`
operationId: webhooks:list_webhook_deliveries
parameters:
- name: endpoint_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid4
- items:
type: string
format: uuid4
type: array
- type: 'null'
description: Filter by webhook endpoint ID.
title: Endpoint Id
description: Filter by webhook endpoint ID.
- name: start_timestamp
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Filter deliveries after this timestamp.
title: Start Timestamp
description: Filter deliveries after this timestamp.
- name: end_timestamp
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Filter deliveries before this timestamp.
title: End Timestamp
description: Filter deliveries before this timestamp.
- name: succeeded
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
description: Filter by delivery success status.
title: Succeeded
description: Filter by delivery success status.
- name: query
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Query to filter webhook deliveries.
title: Query
description: Query to filter webhook deliveries.
- name: http_code_class
in: query
required: false
schema:
anyOf:
- enum:
- 2xx
- 3xx
- 4xx
- 5xx
type: string
- type: 'null'
description: Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).
title: Http Code Class
description: Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).
- name: event_type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/WebhookEventType'
- type: array
items:
$ref: '#/components/schemas/WebhookEventType'
- type: 'null'
description: Filter by webhook event type.
title: Event Type
description: Filter by webhook event type.
- name: page
in: query
required: false
schema:
type: integer
exclusiveMinimum: 0
description: Page number, defaults to 1.
default: 1
title: Page
description: Page number, defaults to 1.
- name: limit
in: query
required: false
schema:
type: integer
exclusiveMinimum: 0
description: Size of a page, defaults to 10. Maximum is 100.
default: 10
title: Limit
description: Size of a page, defaults to 10. Maximum is 100.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListResource_WebhookDelivery_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- oidc:
- webhooks:read
- webhooks:write
- pat:
- webhooks:read
- webhooks:write
- oat:
- webhooks:read
- webhooks:write
components:
schemas:
WebhookEventType:
type: string
enum:
- checkout.created
- checkout.updated
- checkout.expired
- customer.created
- customer.updated
- customer.deleted
- customer.state_changed
- customer_seat.assigned
- customer_seat.claimed
- customer_seat.revoked
- member.created
- member.updated
- member.deleted
- order.created
- order.updated
- order.paid
- order.refunded
- subscription.created
- subscription.updated
- subscription.active
- subscription.canceled
- subscription.uncanceled
- subscription.revoked
- subscription.past_due
- refund.created
- refund.updated
- product.created
- product.updated
- benefit.created
- benefit.updated
- benefit_grant.created
- benefit_grant.cycled
- benefit_grant.updated
- benefit_grant.revoked
- organization.updated
title: WebhookEventType
ListResource_WebhookDelivery_:
properties:
items:
items:
$ref: '#/components/schemas/WebhookDelivery'
type: array
title: Items
pagination:
$ref: '#/components/schemas/Pagination'
type: object
required:
- items
- pagination
title: ListResource[WebhookDelivery]
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
WebhookDelivery:
properties:
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
succeeded:
type: boolean
title: Succeeded
description: Whether the delivery was successful.
http_code:
anyOf:
- type: integer
- type: 'null'
title: Http Code
description: >-
The HTTP code returned by the URL. `null` if the endpoint was
unreachable.
response:
anyOf:
- type: string
- type: 'null'
title: Response
description: >-
The response body returned by the URL, or the error message if the
endpoint was unreachable.
webhook_event:
$ref: '#/components/schemas/WebhookEvent'
description: The webhook event sent by this delivery.
type: object
required:
- created_at
- modified_at
- id
- succeeded
- http_code
- response
- webhook_event
title: WebhookDelivery
description: A webhook delivery for a webhook event.
Pagination:
properties:
total_count:
type: integer
title: Total Count
max_page:
type: integer
title: Max Page
type: object
required:
- total_count
- max_page
title: Pagination
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
WebhookEvent:
properties:
created_at:
type: string
format: date-time
title: Created At
description: The time Ruba created this record.
modified_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Modified At
description: The time this record last changed.
id:
type: string
format: uuid4
title: Id
description: The stable identifier for this record.
last_http_code:
anyOf:
- type: integer
- type: 'null'
title: Last Http Code
description: >-
Last HTTP code returned by the URL. `null` if no delviery has been
attempted or if the endpoint was unreachable.
succeeded:
anyOf:
- type: boolean
- type: 'null'
title: Succeeded
description: >-
Whether this event was successfully delivered. `null` if no delivery
has been attempted.
skipped:
type: boolean
title: Skipped
description: >-
Whether this event was skipped because the webhook endpoint was
disabled.
payload:
anyOf:
- type: string
- type: 'null'
title: Payload
description: The payload of the webhook event.
type:
$ref: '#/components/schemas/WebhookEventType'
description: The type of the webhook event.
is_archived:
type: boolean
title: Is Archived
description: >-
Whether this event is archived. Archived events can't be
redelivered, and the payload is not accessible anymore.
type: object
required:
- created_at
- modified_at
- id
- skipped
- payload
- type
- is_archived
title: WebhookEvent
description: |-
A webhook event.
An event represent something that happened in the system
that should be sent to the webhook endpoint.
It can be delivered multiple times until it's marked as succeeded,
each one creating a new delivery.
securitySchemes:
oidc:
type: openIdConnect
openIdConnectUrl: /.well-known/openid-configuration
pat:
type: http
description: >-
You can generate a **Personal Access Token** from your
[settings](https://getruba.com/settings).
scheme: bearer
oat:
type: http
description: >-
You can generate an **Organization Access Token** from your
organization's settings.
scheme: bearer
````