Replay a delivery

POST

/v1/deliveries/{id}/replay

curl --request POST \
  --url https://api.inboxcnx.com/v1/deliveries/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/replay \
  --header 'Authorization: Bearer <token>'

Queues a dead-lettered or cancelled delivery again, to resend an event once the receiver is fixed. The endpoint must still be live and subscribed to the event type. A message.enrich call cannot be replayed.

Requires the write:webhooks scope.

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

The delivery is queued again and attempted within about a minute

Media typeapplication/json

object

id

required

string

status

required

string

Allowed values: pending failed success dlq cancelled

Example

{
  "id": "6d4e2f1a-9b8c-4d7e-a5f6-0c1b2a3d4e5f",
  "status": "pending"
}

403

The credential lacks the write:webhooks scope

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

No such delivery for the caller’s organization; the delivery history is kept for 30 days

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Only a dlq or cancelled delivery can be replayed, never a message.enrich call, and only to a live endpoint still subscribed to its event type

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

410

The event’s payload is deleted: once every delivery of the event has ended, or 7 days after the event

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}