Docs
REST API v1

List webhook deliveries

List webhook deliveries in the authenticated project environment.

GET/v1/webhooks/{endpointId}/deliveries

Requirements

A secret API key with webhooks:read. Resources are restricted to the key's project and environment.

Path parameters

NameTypeRequired / defaultDescription
endpointIdstringRequiredID returned when creating the webhook.

Query parameters

NameTypeRequired / defaultDescription
projectIdstringKey projectMust match the key's project.
environmentIdstringKey environmentMust match the key's environment.
limitinteger50From 1 to 100.
offsetinteger0From 0 to 100,000.
statusstringOptionalpending, delivering, succeeded, failed or cancelled.

Example

Set RELAYRTC_API_URL to your API base including /v1, such as http://localhost:8082/v1.

Shell
curl -X GET "$RELAYRTC_API_URL/webhooks/webhook_example/deliveries" \
  -H "Authorization: Bearer $RELAYRTC_SECRET_KEY"

Response

200 with deliveries and offset pagination.

JSON
{
  "deliveries": [],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 0
  }
}

Errors

Invalid fields return 400. Invalid credentials return 401; a missing scope returns 403. A missing resource returns 404. See error responses.