API reference

Events

Send single events and batches into Pushrail.

• POST/eventsIngest a single event
• POST/events/batchIngest a batch of events

Destinations

Configure where events get delivered.

• GET/destinationsList destinations
• POST/destinationsCreate a destination
• GET/destinations/{id}Get a destination
• PATCH/destinations/{id}Update a destination
• DELETE/destinations/{id}Delete a destination
• POST/destinations/{id}/enableEnable a destination
• POST/destinations/{id}/disableDisable a destination
• POST/destinations/{id}/testTest a destination connection

Routing rules

Match events to destinations.

• GET/routing-rulesList routing rules
• POST/routing-rulesCreate a routing rule
• GET/routing-rules/{id}Get a routing rule
• PATCH/routing-rules/{id}Update a routing rule
• DELETE/routing-rules/{id}Delete a routing rule
• POST/routing-rules/{id}/enableEnable a routing rule
• POST/routing-rules/{id}/disableDisable a routing rule

Deliveries

Inspect delivery state and attempt history.

• GET/deliveriesList deliveries
• GET/deliveries/{id}Get a delivery
• GET/events/{id}/deliveriesList deliveries for an event
• GET/destinations/{id}/deliveriesList deliveries for a destination

Replay

Re-send failed or selected past deliveries.

• GET/replay-jobsList replay jobs
• POST/replay-jobsCreate a replay job
• GET/replay-jobs/{id}Get a replay job
• POST/replay-jobs/{id}/cancelCancel a replay job
• GET/replay-jobs/{id}/progressGet replay job progress

Event schemas

Declare the events your product emits.

• GET/schemasList event schemas
• POST/schemasCreate an event schema
• GET/schemas/types/{eventType}/versionsList versions of an event schema
• GET/schemas/types/{eventType}/activeGet the active version of an event schema
• GET/schemas/{id}Get an event schema version
• POST/schemas/{id}/activatePublish (activate) an event schema version

Transforms

Reshape payloads before delivery.

• GET/destinations/{destinationId}/transform-scriptsList transform scripts for a destination
• POST/transform-scriptsCreate a transform script
• GET/transform-scripts/{id}Get a transform script
• POST/transform-scripts/{id}/publishPublish a transform script version

DLQ

Manage permanently-failed deliveries.

• GET/dlqList dead-letter deliveries
• GET/dlq/{deliveryId}Get a dead-letter delivery
• POST/dlq/{deliveryId}/retryRequeue a dead-letter delivery

Embed

Mint sessions for the in-product portal.

• POST/embed/sessionsMint an embed session for a customer account

Files

Upload and fetch file artifacts.

• GET/filesList files
• POST/filesUpload a file
• GET/files/{id}Get a file

Observability

Per-destination health and metrics.

• GET/destinations/{id}/healthGet destination health
• GET/destinations/{id}/analyticsGet destination delivery metrics
• GET/observability/throughputGet delivery throughput metrics

Audit

Read the audit trail of configuration changes.

• GET/audit-logsList audit log entries
• GET/audit-logs/{id}Get an audit log entry

Authentication

• GET/auth/contextGet auth context

Invitations

• GET/invitations/{token}Preview an invitation
• POST/invitations/{token}/acceptAccept an invitation

OAuth

• POST/oauth/registerDynamic client registration
• POST/oauth/tokenToken endpoint
• POST/oauth/device_authorizationDevice authorization endpoint