alert_delivery_list

Optional query parameters to this endpoint may be used to filter deliveries by state. If none of the failed, pending or delivered query parameters are present, all deliveries are returned. If one or more of these parameters are provided, only those which are set to "true" are included in the response.

get/v1/alert-receivers/{receiver}/deliveries

Path Parameters

receiver

The name or ID of the webhook receiver.

Query Parameters

delivered

If true, include deliveries which have succeeded.

If any of the "pending", "failed", or "delivered" query parameters are set to true, only deliveries matching those state(s) will be included in the response. If NO state filter parameters are set, then all deliveries are included.

failed

If true, include deliveries which have failed permanently.

If any of the "pending", "failed", or "delivered" query parameters are set to true, only deliveries matching those state(s) will be included in the response. If NO state filter parameters are set, then all deliveries are included.

A delivery fails permanently when the retry limit of three total attempts is reached without a successful delivery.

pending

If true, include deliveries which are currently in progress.

If any of the "pending", "failed", or "delivered" query parameters are set to true, only deliveries matching those state(s) will be included in the response. If NO state filter parameters are set, then all deliveries are included.

A delivery is considered "pending" if it has not yet been sent at all, or if a delivery attempt has failed but the delivery has retries remaining.

limit

Maximum number of items returned by a single call

page_token

Token returned by previous call to retrieve the subsequent page

sort_by

Supported set of sort modes for scanning by timestamp and ID

Responses

Object
items

list of items on this page of results

A delivery of a webhook event.

Object
alert_class

The event class.

alert_id

The UUID of the event.

attempts

Individual attempts to deliver this webhook event, and their outcomes.

A list of attempts to deliver an alert to a receiver.

The type of the delivery attempt model depends on the receiver type, as it may contain information specific to that delivery mechanism. For example, webhook delivery attempts contain the HTTP status code of the webhook request.

id

The UUID of this delivery attempt.

receiver_id

The UUID of the alert receiver that this event was delivered to.

state

The state of this delivery.

The state of a webhook delivery attempt.

time_started

The time at which this delivery began (i.e. the event was dispatched to the receiver).

trigger

Why this delivery was performed.

The reason an alert was delivered

next_page

token used to fetch the next page of results (if any)