Retrieve a webhook delivery

GET/webhooks/deliveries/{id}

One delivery attempt including the payload that was sent — the list endpoint omits payloads. Use this to inspect the exact body your endpoint received, or to forward it somewhere else (this is how printedsimply listen replays events to localhost). event_id is the logical event this attempt belongs to, and equals payload.id.

Credential: An API key in x-api-key
Scopes: webhooks:manage

Parameters

idpath · stringrequired

Request

Try it

GET /api/v1/webhooks/deliveries/{id}

curl "https://portal.printedsimply.com/api/v1/webhooks/deliveries/ccbkfrz5r3gcby08k4iqiuxwb" \
  -H "x-api-key: ps_test_YOUR_KEY"

Response `200`

The attempt, with the exact body that was POSTed so a receiver that lost one can replay it against its own handler.

data

idstringrequired
webhook_idstringrequired
eventstringrequired
One of order.created order.paid order.in_production order.shipped order.delivered order.cancelled order.failed order.updated order.rerouted order.quality_check order.issue order.approval_requested order.approval_approved order.approval_declined order.approval_expired campaign.opened campaign.order_added campaign.closed campaign.batch_in_production campaign.completed design.proof_sent design.changes_requested design.approved return.requested return.approved return.remake_created return.resolved return.rejected drop.opened drop.sale drop.closed drop.sold_out checkout_link.sale gift.claimed gift.expired product.updated catalog.synced webhook.disabled autopilot.run.created autopilot.run.awaiting_approval autopilot.run.completed autopilot.run.failed autopilot.run.cancelled design_run.item_ready design_run.completed guarantee.issued guarantee.honored guarantee.breached guarantee.remedied test.ping
event_idstring | null
Null only for attempts recorded before the log carried the id.
status_codeinteger | null
successbooleanrequired
failure_causestring | null
Why a failed attempt failed, and so what to fix: dns, refused, timeout, tls, reset, redirect, unauthorized and the other endpoint-side causes are your URL's; egress, signing and internal are ours, and the attempt is retried on schedule. Null when delivered, and on a failure logged with neither a cause nor a status.
One of dns unsafe_url refused timeout tls reset network redirect unauthorized http_4xx http_5xx inbox_refused egress signing internal
created_atstring (date-time)required
payloadobjectrequired
The exact body that was POSTed, so a receiver that lost one can replay it against its own handler. Its id is the same value as event_id beside it — surfaced as its own key so reading the log does not mean reaching into an opaque body for the dedupe key.

meta

pageinteger
totalinteger
limitinteger
The page size actually applied, which is not necessarily the one asked for — the operation's own ceiling wins.
pagesinteger
total over limit, rounded up.
next_cursorstring | null
On a cursor-paged operation: send this back as cursor for the next page. Null on the last page. Absent on operations that do not page by cursor.
has_moreboolean
On a list operation whose meta is ListMeta: whether another page follows this one.

Example response

{
  "status": "success",
  "data": {
    "id": "ccbkfrz5r3gcby08k4iqiuxwb",
    "webhook_id": "whk_hCyrY24j_gUrQWxJ7ji6s9st",
    "event": "order.shipped",
    "event_id": "evt_ey8SQMTGI1sCP-c0JpwB3AyX",
    "payload": {
      "id": "evt_ey8SQMTGI1sCP-c0JpwB3AyX",
      "data": {
        "status": "shipped",
        "event_id": "evt_o0ONdH8-7LUjFVrEVoIyufJ0",
        "order_id": "test_ord_wVK9ZiG-VYiPrlSeBUBmrUVk",
        "provider": "printedsimply",
        "tracking": {
          "url": "https://portal.printedsimply.com/track/eyJ2IjoxLCJ0IjoidHJhY2tpbmciLCJ0b2siOiJ0cmtfQXF1SkZxRExEa2lzSzZKaC1IQUJIejlMIiwiZXhwIjoiMjAyNy0wMS0xM1QxNTowMDozMi4wMDBaIn0.50de0b297f5ed5a39f7b618a2e6f8138f8d50b31a2daabe2709af8f2d7265b25",
          "number": "TRK-TEST-JCWX8ET5IGBT",
          "carrier": "UPS"
        },
        "test_mode": true,
        "tracking_url": "https://portal.printedsimply.com/track/eyJ2IjoxLCJ0IjoidHJhY2tpbmciLCJ0b2siOiJ0cmtfQXF1SkZxRExEa2lzSzZKaC1IQUJIejlMIiwiZXhwIjoiMjAyNy0wMS0xM1QxNTowMDozMi4wMDBaIn0.50de0b297f5ed5a39f7b618a2e6f8138f8d50b31a2daabe2709af8f2d7265b25",
        "portal_order_id": "ord_wVK9ZiG-VYiPrlSeBUBmrUVk",
        "tracking_number": "TRK-TEST-JCWX8ET5IGBT",
        "tracking_carrier": "UPS",
        "estimated_delivery": {
          "latest": "2026-10-29",
          "earliest": "2026-10-23",
          "ships_by": "2026-10-19",
          "is_estimate": true
        }
      },
      "event": "order.shipped",
      "timestamp": "2026-10-15T15:00:32.000Z"
    },
    "status_code": 200,
    "success": true,
    "failure_cause": null,
    "created_at": "2026-10-15T15:00:32.000Z"
  },
  "request_id": "4e3753e1-48dd-4313-bfd8-48e4af4e116a"
}

Errors

401invalid_api_key missing_api_key key_expired
Missing, invalid or expired API key: missing_api_key (none sent), invalid_api_key (unknown or revoked), key_expired (past the expiry set when it was created; create a new key).
404
Resource not found
429rate_limit_exceeded daily_quota_exceeded
Rate limit exceeded. Two windows can produce this status and error.code says which: rate_limit_exceeded for the per-minute sliding window, daily_quota_exceeded for the plan's daily quota. Both carry Retry-After; the daily one also carries X-Daily-Limit and X-Daily-Remaining. The per-minute limits are plan-based — see Rate Limits above, or call GET /v1/me for this credential's own figures.

Every Webhooks operation

Response 200

The attempt, with the exact body that was POSTed so a receiver that lost one can replay it against its own handler.

data

idstringrequired
webhook_idstringrequired
eventstringrequired
One of order.created order.paid order.in_production order.shipped order.delivered order.cancelled order.failed order.updated order.rerouted order.quality_check order.issue order.approval_requested order.approval_approved order.approval_declined order.approval_expired campaign.opened campaign.order_added campaign.closed campaign.batch_in_production campaign.completed design.proof_sent design.changes_requested design.approved return.requested return.approved return.remake_created return.resolved return.rejected drop.opened drop.sale drop.closed drop.sold_out checkout_link.sale gift.claimed gift.expired product.updated catalog.synced webhook.disabled autopilot.run.created autopilot.run.awaiting_approval autopilot.run.completed autopilot.run.failed autopilot.run.cancelled design_run.item_ready design_run.completed guarantee.issued guarantee.honored guarantee.breached guarantee.remedied test.ping
event_idstring | null
Null only for attempts recorded before the log carried the id.
status_codeinteger | null
successbooleanrequired
failure_causestring | null
Why a failed attempt failed, and so what to fix: dns, refused, timeout, tls, reset, redirect, unauthorized and the other endpoint-side causes are your URL's; egress, signing and internal are ours, and the attempt is retried on schedule. Null when delivered, and on a failure logged with neither a cause nor a status.
One of dns unsafe_url refused timeout tls reset network redirect unauthorized http_4xx http_5xx inbox_refused egress signing internal
created_atstring (date-time)required
payloadobjectrequired
The exact body that was POSTed, so a receiver that lost one can replay it against its own handler. Its id is the same value as event_id beside it — surfaced as its own key so reading the log does not mean reaching into an opaque body for the dedupe key.

meta

pageinteger
totalinteger
limitinteger
The page size actually applied, which is not necessarily the one asked for — the operation's own ceiling wins.
pagesinteger
total over limit, rounded up.
next_cursorstring | null
On a cursor-paged operation: send this back as cursor for the next page. Null on the last page. Absent on operations that do not page by cursor.
has_moreboolean
On a list operation whose meta is ListMeta: whether another page follows this one.

Example response

{
  "status": "success",
  "data": {
    "id": "ccbkfrz5r3gcby08k4iqiuxwb",
    "webhook_id": "whk_hCyrY24j_gUrQWxJ7ji6s9st",
    "event": "order.shipped",
    "event_id": "evt_ey8SQMTGI1sCP-c0JpwB3AyX",
    "payload": {
      "id": "evt_ey8SQMTGI1sCP-c0JpwB3AyX",
      "data": {
        "status": "shipped",
        "event_id": "evt_o0ONdH8-7LUjFVrEVoIyufJ0",
        "order_id": "test_ord_wVK9ZiG-VYiPrlSeBUBmrUVk",
        "provider": "printedsimply",
        "tracking": {
          "url": "https://portal.printedsimply.com/track/eyJ2IjoxLCJ0IjoidHJhY2tpbmciLCJ0b2siOiJ0cmtfQXF1SkZxRExEa2lzSzZKaC1IQUJIejlMIiwiZXhwIjoiMjAyNy0wMS0xM1QxNTowMDozMi4wMDBaIn0.50de0b297f5ed5a39f7b618a2e6f8138f8d50b31a2daabe2709af8f2d7265b25",
          "number": "TRK-TEST-JCWX8ET5IGBT",
          "carrier": "UPS"
        },
        "test_mode": true,
        "tracking_url": "https://portal.printedsimply.com/track/eyJ2IjoxLCJ0IjoidHJhY2tpbmciLCJ0b2siOiJ0cmtfQXF1SkZxRExEa2lzSzZKaC1IQUJIejlMIiwiZXhwIjoiMjAyNy0wMS0xM1QxNTowMDozMi4wMDBaIn0.50de0b297f5ed5a39f7b618a2e6f8138f8d50b31a2daabe2709af8f2d7265b25",
        "portal_order_id": "ord_wVK9ZiG-VYiPrlSeBUBmrUVk",
        "tracking_number": "TRK-TEST-JCWX8ET5IGBT",
        "tracking_carrier": "UPS",
        "estimated_delivery": {
          "latest": "2026-10-29",
          "earliest": "2026-10-23",
          "ships_by": "2026-10-19",
          "is_estimate": true
        }
      },
      "event": "order.shipped",
      "timestamp": "2026-10-15T15:00:32.000Z"
    },
    "status_code": 200,
    "success": true,
    "failure_cause": null,
    "created_at": "2026-10-15T15:00:32.000Z"
  },
  "request_id": "4e3753e1-48dd-4313-bfd8-48e4af4e116a"
}

Errors

401invalid_api_key missing_api_key key_expired

Missing, invalid or expired API key: missing_api_key (none sent), invalid_api_key (unknown or revoked), key_expired (past the expiry set when it was created; create a new key).

404

Resource not found

429rate_limit_exceeded daily_quota_exceeded

Rate limit exceeded. Two windows can produce this status and error.code says which: rate_limit_exceeded for the per-minute sliding window, daily_quota_exceeded for the plan's daily quota. Both carry Retry-After; the daily one also carries X-Daily-Limit and X-Daily-Remaining. The per-minute limits are plan-based — see Rate Limits above, or call GET /v1/me for this credential's own figures.

Retrieve a webhook delivery

Parameters

Request

Response 200

Errors

Retrieve a webhook delivery

Parameters

Request

Response 200

Errors

Response `200`

Response `200`