def list_all_deliveries(
id,
limit: nil,
offset: nil,
status: nil,
timeout: nil
)def list_all_deliveries: (
String id,
?limit: Integer?,
?offset: Integer?,
?status: ("pending" | "processing" | "succeeded" | "failed")?,
?timeout: seconds?
) -> Array[webhook_delivery_resource]Walks every page of one endpoint delivery log and returns a flat array. Unlike the endpoint list, this collection has no small cap: a busy endpoint accumulates deliveries indefinitely, so narrow with status: or reach for iterate_deliveries when you only need the first few matches.
The pagination envelope is dropped, so totalCount is gone. responseBody is absent from every row here as well, exactly as in list_deliveries.
Example
require "envless/sdk"
endpoint_id = "0194f2b1-9c3a-7c21-8f0e-2b6d4a1c5e90"
failed = Envless.webhooks.list_all_deliveries(
endpoint_id,
status: "failed"
)
failed.each do |delivery|
Envless.webhooks.redeliver(delivery[:webhookId], delivery[:id])
endParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | String | Yes | Endpoint id whose delivery log is walked. |
status: | "pending" | "processing" | "succeeded" | "failed" | No | Restricts the walk to one delivery state such as failed. |
limit: | Integer | No | Page size used while walking, capped at 100 and defaulting to 100. |
offset: | Integer | No | Row the walk starts from, so newer deliveries are left out of the result. |
timeout: | Integer | Float | Rational | No | Seconds each attempt of this call may take, redirects and the response body included, before it raises Envless::NetworkError with timeout? set. Overrides the client's timeout for this call, and 0 turns the limit off. |
Returns
Array[webhook_delivery_resource] holding each matching delivery attempt for the endpoint.
Reads the deliveries collection. list returns one page as an Envless::Page with items and pagination, list_all collects every page into an array, and iterate yields one item at a time to a block, fetching the next page only when it gets there. Without a block, iterate returns an Enumerator.
Worth knowing
- Every page is a separate read, so a delivery that retried mid walk can land in the array with a stale
status. - A failure on any page fails the whole call and the rows already collected are lost.
Required scopes
webhooks:read
Underlying endpoint
GET /webhooks/{id}/deliveries
Request and response schema, every error code, and a live playground.
In TypeScript
envless.webhooks.listAllDeliveries()
The same method in @goenvless/sdk, with the same request, retries and errors.