alert_receiver_probe

This endpoint synchronously sends a liveness probe to the selected alert receiver. The response message describes the outcome of the probe: either the successful response (as appropriate), or indication of why the probe failed.

The result of the probe is represented as an AlertDelivery model. Details relating to the status of the probe depend on the alert delivery mechanism, and are included in the AlertDeliveryAttempts model. For example, webhook receiver liveness probes include the HTTP status code returned by the receiver endpoint.

Note that the response status is 200 OK as long as a probe request was able to be sent to the receiver endpoint. If an HTTP-based receiver, such as a webhook, responds to the another status code, including an error, this will be indicated by the response body, not the status of the response.

The resend query parameter can be used to request re-delivery of failed events if the liveness probe succeeds. If it is set to true and the liveness probe succeeds, any alerts for which delivery to this receiver has failed will be queued for re-delivery.

post/v1/alert-receivers/{receiver}/probe

Path Parameters

receiver

The name or ID of the webhook receiver.

Query Parameters

resend

If true, resend all events that have not been delivered successfully if the probe request succeeds.

Responses

Object
probe

The outcome of the probe delivery.

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

resends_started

If the probe request succeeded, and resending failed deliveries on success was requested, the number of new delivery attempts started. Otherwise, if the probe did not succeed, or resending failed deliveries was not requested, this is null.

Note that this may be 0, if there were no events found which had not been delivered successfully to this receiver.