Webhooks

$envless->webhooks->listAllDeliveries()

Collect every delivery attempt into one array

php
/** @return list<WebhookDeliveryResource> */
public function listAllDeliveries(
    string $id,
    ?int $limit = null,
    ?int $offset = null,
    ?string $status = null,
    int|float|null $timeout = null,
): array

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 iterateDeliveries 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 listDeliveries.

Example

php
use Envless\Envless;

$envless = new Envless();

$failed = $envless->webhooks->listAllDeliveries(
    '0194f2b1-9c3a-7c21-8f0e-2b6d4a1c5e90',
    status: 'failed',
);

foreach ($failed as $delivery) {
    $envless->webhooks->redeliver($delivery['webhookId'], $delivery['id']);
}

Parameters

ParameterTypeRequiredDescription
$idstringYesEndpoint id whose delivery log is walked.
$statusstringNoRestricts the walk to one delivery state such as failed.
$limitintNoPage size used while walking, capped at 100 and defaulting to 100.
$offsetintNoRow the walk starts from, so newer deliveries are left out of the result.
$timeoutint|floatNoSeconds each attempt of this call may take, the response body included, before it throws Envless\Exception\NetworkException with isTimeout() true. Overrides the client's timeout for this call, and 0 turns the limit off.

Returns

list<WebhookDeliveryResource> holding each matching delivery attempt for the endpoint.

Reads the deliveries collection. list returns one page as an Envless\Result\Page with items and pagination, listAll collects every page into an array, and iterate returns a Generator that yields one item at a time, fetching the next page only when the loop gets there.

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.