alerts

Send a synthetic test notification to subscribed users and every active destination on this alert.

post/api/projects/{project_id}/alerts/{id}/test-delivery/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/alerts/{id}/test-delivery/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this alert configuration.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

destination_countinteger required

Number of active destinations queued for test delivery.

email_recipient_countinteger required

Number of subscribed users sent a test email.

failed_delivery_channelsFailedDeliveryChannelsEnum[] required

Configured delivery channels that failed to schedule or send.

Changes

No recorded changes to this operation across all 1 revision of this API.