Notify API reference

Notify API · Deliveries

get/v1/workspaces/{workspace_id}/deliveries/{delivery_id}Auth

Get a delivery

With every provider attempt (status, code, duration; no message content).

Path parameters

workspace_id*string · uuid

Id of the workspace.

delivery_id*string · uuid

The delivery id.

Response · 200 The delivery.

id*string · uuid

The delivery id.

notification_id*string · uuid

The notification.

recipient_id*string · uuid

The recipient id.

recipient_external_id*string

The recipient external id (null after an erasure).

channel*object

The channel.

provider*string

`inbox`, `mail`, `apns`, `fcm` or `webpush`.

device_id*string · uuid

The device, for push and web push.

target*string

`inbox`, `email:<address hash>` or `device:<id>`; `email:erased:<delivery id>` once the recipient was erased.

fallback_step*integer

0 for an `always` channel; n for the n-th fallback step.

is_fallback*boolean

Planned because an earlier step failed.

state*object

The state.

reason*object

Why it was skipped, held, retried or failed (`mail_refused:<code>` carries Mail's code).

explanation*string

What the reason means and how to fix it.

attempts*integer

Provider calls made.

next_attempt_at*string · date-time

Next try (retry, scheduled).

provider_message_id*string

Provider message id (APNs `apns-id`, FCM message name, Mail message id).

provider_unique_id*string

APNs `apns-unique-id` (sandbox only).

rendered*object

The push or web push title and body as sent (kept 30 days).

warnings*array

Render warnings: `template_variable_missing:<name>`, `unsafe_url:<field>`.

sent_at*string · date-time

Handed to the provider (or written to the inbox).

final_at*string · date-time

Reached its final state.

created_at*string · date-time

Planned.

attempts_log*array

Provider calls, oldest first (no PII, no provider bodies).

Example

Request

GET https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/deliveries/{delivery_id}
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "notification_id": "00000000-0000-0000-0000-000000000000",
  "recipient_id": "00000000-0000-0000-0000-000000000000",
  "recipient_external_id": "string",
  "channel": {},
  "provider": "string",
  "device_id": "00000000-0000-0000-0000-000000000000",
  "target": "string",
  "fallback_step": 0,
  "is_fallback": false,
  "state": {},
  "reason": {},
  "explanation": "string",
  "attempts": 0,
  "next_attempt_at": "2026-01-01T00:00:00.000Z",
  "provider_message_id": "string",
  "provider_unique_id": "string",
  "rendered": {},
  "warnings": [
    "string"
  ],
  "sent_at": "2026-01-01T00:00:00.000Z",
  "final_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "attempts_log": [
    {
      "attempt": 0,
      "outcome": "string",
      "provider_status": 0,
      "provider_code": "string",
      "retry_after_s": 0,
      "duration_ms": 0,
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}