Get webhook replay status

GET/v1/webhook_endpoints/{endpoint}/replays/{replay}

Read durable replay progress and its immutable terminal verdict. During ordinary operation, a successfully completed replay remains readable for at least 30 days after terminal_at, then returns the same tenant-scoped 404 as an unknown replay. Pending and running replays are never age-swept; failed replay evidence has no scheduled expiry.

Path ParametersExpand Collapse

endpoint: string

replay: string

ReturnsExpand Collapse

Replay object { id, after_cursor, created_at, 12 more }

id: string

after_cursor: string

created_at: string

formatdate-time

delivered: number

formatint32

delivering: number

formatint32

exhausted: number

formatint32

failure_reason: string

materialized: number

formatint32

pending: number

formatint32

selected: number

formatint32

started_at: string

formatdate-time

state: "pending" or "running" or "completed" or "failed"

One of the following:

"pending"

"running"

"completed"

"failed"

terminal_at: string

formatdate-time

through_cursor: string

unmaterialized: number

formatint32

Get webhook replay status

curl https://whatsapp.messages.api.linqapp.com/v1/webhook_endpoints/$ENDPOINT/replays/$REPLAY \
    -H "Authorization: Bearer $LINQ_WHATSAPP_API_KEY"

{
  "id": "id",
  "after_cursor": "after_cursor",
  "created_at": "2019-12-27T18:11:19.117Z",
  "delivered": 0,
  "delivering": 0,
  "exhausted": 0,
  "failure_reason": "failure_reason",
  "materialized": 0,
  "pending": 0,
  "selected": 0,
  "started_at": "2019-12-27T18:11:19.117Z",
  "state": "pending",
  "terminal_at": "2019-12-27T18:11:19.117Z",
  "through_cursor": "through_cursor",
  "unmaterialized": 0
}

Returns Examples

{
  "id": "id",
  "after_cursor": "after_cursor",
  "created_at": "2019-12-27T18:11:19.117Z",
  "delivered": 0,
  "delivering": 0,
  "exhausted": 0,
  "failure_reason": "failure_reason",
  "materialized": 0,
  "pending": 0,
  "selected": 0,
  "started_at": "2019-12-27T18:11:19.117Z",
  "state": "pending",
  "terminal_at": "2019-12-27T18:11:19.117Z",
  "through_cursor": "through_cursor",
  "unmaterialized": 0
}