subscriptions
subscriptions

Retrieve subscription delivery

Fetch one delivery row by id.

get/api/projects/{project_id}/subscriptions/{subscription_id}/deliveries/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/subscriptions/{subscription_id}/deliveries/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this subscription delivery.

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/.

subscription_idinteger required

Response

idstring uuid required

Primary key for this delivery row.

subscriptioninteger required

Parent subscription id.

temporal_workflow_idstring required

Temporal workflow id for this delivery run.

idempotency_keystring required

Dedupes activity retries for the same logical run.

trigger_typestring required

Why the run started (e.g. scheduled, manual, subscription update).

scheduled_atstring date-time nullable required

Planned send time when applicable.

target_typestring required

Channel snapshot at send time: email, slack, or teams.

target_valuestring required

Destination snapshot at send time: the email list, the Slack channel id, or the host of the Microsoft Teams webhook. The webhook URL itself is never returned.

exported_asset_idsinteger[] required

ExportedAsset ids generated for this send.

content_snapshotunknown required
recipient_resultsunknown required
status'starting' | 'completed' | 'failed' | 'skipped' required
  • starting - Starting
  • completed - Completed
  • failed - Failed
  • skipped - Skipped
errorunknown required
created_atstring date-time required

When the delivery row was created.

last_updated_atstring date-time required

Last ORM update to this row.

finished_atstring date-time nullable required

When the run finished, if applicable.

change_summarystring nullable required

AI-generated summary included in this delivery, when one was produced.

ai_reportstring nullable required

AI-generated report markdown delivered by this run. Null for non-AI deliveries or runs without a persisted report.

ai_report_promptstring nullable required

The subscription's prompt as it was when this report was generated. Null for older deliveries and non-AI deliveries.

Changes

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