Webhooks

$envless->webhooks->iterate()

Stream webhook endpoints one at a time

php
/** @return \Generator<int, WebhookResource, mixed, void> */
public function iterate(
    ?int $limit = null,
    ?int $offset = null,
    ?string $search = null,
    ?string $order = null,
    int|float|null $timeout = null,
): \Generator

Returns a Generator that yields endpoints individually and fetches the next page only once the current one is drained. Nothing is requested until you start consuming it, and breaking out of the loop stops the requests, so this is the cheapest way to find the endpoint pointed at one URL.

The generator defaults to the maximum page size of 100 and clamps anything larger, so limit only ever makes pages smaller. Creating or deleting endpoints while you iterate shifts the offsets the walk counts against, so collect ids first and act on them after the loop.

Example

php
use Envless\Envless;

$envless = new Envless();

foreach ($envless->webhooks->iterate() as $hook) {
    if ($hook['url'] === 'https://hooks.example.com/envless') {
        echo $hook['id'], ' ', implode(', ', $hook['eventTypes']), PHP_EOL;

        break;
    }
}

Parameters

ParameterTypeRequiredDescription
$limitintNoPage size per request, capped at 100 and defaulting to 100.
$offsetintNoRow the walk starts at, advancing by the number of items each page returns.
$searchstringNoCase insensitive substring match across name, url and description.
$orderstringNoDefaults to name, which sorts A to Z. Pass asc for oldest first or desc for newest first on createdAt.
$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

Generator<int, WebhookResource> yielding one endpoint per step.

Reads the webhooks 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

  • The generator is lazy, so an abandoned loop costs at most the pages you consumed.

Required scopes

webhooks:read

Underlying endpoint

GET /webhooks

Request and response schema, every error code, and a live playground.

In TypeScript

envless.webhooks.iterate()

The same method in @goenvless/sdk, with the same request, retries and errors.