Recent delivery attempts for a webhook
Lists a webhook's recent delivery attempts: event type, the id of the resource the event is about, attempt number, status, response code, error and time. The newest deliveries first, at most limit (default 50). A delivery of a batch event is left out for a caller without batch read access, and one of a balance event for a caller without billing read access, so a page can hold fewer than limit.
Required permission
Requires the webhook.read permission. See Permissions for the roles and API key permissions that include it.
Command line
The orl CLI wraps this endpoint:
orl webhooks delivery list <id>apiKeyAuthorizationBearer <token>OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).
orgId*stringid*stringlimit?integerDeliveries
application/json- response
[index: integer]?curl -X GET 'https://api.openrelay.inc/v1/orgs/string/webhooks/string/deliveries'[ { "id": "string", "eventType": "string", "eventId": "string", "attemptNumber": 0, "status": "string", "statusCode": 0, "errorMessage": "string", "createdAt": "string", "deliveredAt": "string" }]Regenerate a webhook secret (returned once) POST
Replaces the webhook's signing secret and returns the new whsec_ secret once. Later deliveries, retries included, are signed with the new secret.
VM and pod events Webhook
Sent when a VM starts, or a VM or pod stops, is terminated, is interrupted or recovers, to each enabled webhook that lists the event or lists none. vm.running: a VM reached running from deploying, on its first start, on every later start of a stopped or failed VM and on every restart, a reboot of a running VM included; or a VM or pod recovered from an interruption. A pod's start, first or later, sends none. vm.stopped: a VM or pod was stopped. vm.terminated: a VM or pod was terminated. vm.interrupted: a VM or pod stopped serving through no action of yours, for example because its node went offline. It usually recovers on its own and sends vm.running again; one still interrupted after 7 days, or whose node is removed, is ended instead: a pod as terminated, which sends vm.terminated, and a VM as stopped, which sends no event. The events cover the VMs and pods your organization lists; the nodes of a managed Kubernetes cluster send none. Delivery is at least once: the same change can occasionally be recorded as a second event, with a new event id and a new delivery id.