client.webhookDeliveriesOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/webhook-deliverieswebhookDeliveries.list
Returns only deliveries owned by the authenticated service credential. The App re-authenticates the credential and reapplies ownership and workspace isolation in the cell.
client.webhookDeliveries.list(options?: WebhookDeliveryListOptions)- Return form
Promise- Operation ID
listWebhookDeliveries- Required scopes
webhooks:read- SDK parameters
options: WebhookDeliveryListOptions- Query request fields
cursor?: stringlimit?: integerwebhookId?: stringstate?: stringevent?: string- Success
200 Array<WebhookDelivery> envelope
/webhook-deliveries/{id}webhookDeliveries.get
Returns a credential-owned delivery after the cell-local App reapplies credential ownership and workspace isolation.
client.webhookDeliveries.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getWebhookDelivery- Required scopes
webhooks:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 WebhookDelivery envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
webhookDeliveries.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.webhookDeliveries.pages(options?: WebhookDeliveryListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.