webhooks.deliveries.list

Import and client

import { RelayServer } from '@relayrtc/node'
 
const relay = new RelayServer({
  apiUrl: process.env.RELAYRTC_API_URL!,
  apiKey: process.env.RELAYRTC_SECRET_KEY!,
})

Requirements

A secret key with webhooks:read. The requested resource must belong to that key's project environment.

Parameters

Option	Type	Default / requirement	Purpose
endpointId	string	Required	ID returned when creating the webhook.
projectId	string	Key project	Must match the key's project.
environmentId	string	Key environment	Must match the key's environment.
limit	integer	50	From 1 to 100.
offset	integer	0	From 0 to 100,000.
status	string	Optional	pending, delivering, succeeded, failed or cancelled.

Every method accepts RequestOptions as its final argument.

Example

const endpointId = 'webhook_example'
const result = await relay.webhooks.deliveries.list(endpointId, { status: 'failed', limit: 20 })

Returns

Promise<WebhookDeliveryList>. Returns deliveries and offset pagination.

REST equivalent

GET /v1/webhooks/{endpointId}/deliveries. Failures throw RelayApiError.