Webhooks

Recent delivery attempts for a webhook

Changed on

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.

Requires the webhook.read permission. See Permissions for the roles and API key permissions that include it.

get/v1/orgs/{orgId}/webhooks/{id}/deliveries

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/webhooks/{id}/deliveries
  • Auth
    HTTP bearer

Path parameters

orgIdstring required
idstring required

Query parameters

limitinteger

Response

Deliveries

attemptNumberinteger required
createdAtstring required
deliveredAtstring
errorMessagestring

Why the attempt failed: the receiver's HTTP status and the start of its body when it answered, or one sentence of OpenRelay's when it did not.

eventIdstring required

The id of what the event is about, a VM or pod, a batch, or the organization for a balance event.

eventTypestring required
idstring required
statusstring required
statusCodeinteger

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status