Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Endpoint

Bulk Replay Messages

Bulk replay messages sent to the endpoint.

Only messages that were created after since will be sent. This will replay both successful, and failed messages

A completed task will return a payload like the following:

{
  "id": "qtask_33qen93MNuelBAq1T9G7eHLJRsF",
  "status": "finished",
  "task": "endpoint.bulk-replay",
  "data": {
    "messagesSent": 2
  }
}
post/api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

sincestring date-time required
untilstring date-time nullable
eventTypesstring[] nullable
channelstring nullable
tagstring nullable
status0 | 1 | 2 | 3 | 4

The sending status of the message:

  • Success = 0
  • Pending = 1
  • Fail = 2
  • Sending = 3
  • Canceled = 4
statusCodeClass0 | 100 | 200 | 300 | 400 | 500

The different classes of HTTP status codes:

  • CodeNone = 0
  • Code1xx = 100
  • Code2xx = 200
  • Code3xx = 300
  • Code4xx = 400
  • Code5xx = 500

Example request

{
  "eventTypes": [
    "user.signup"
  ],
  "channel": "project_1337",
  "tag": "project_1337"
}

Response

idstring required

The QueueBackgroundTask's ID.

status'running' | 'finished' | 'failed' required
task'endpoint.replay' | 'endpoint.recover' | 'application.stats' | 'message.broadcast' | 'sdk.generate' | 'event-type.aggregate' | 'application.purge_content' | 'endpoint.bulk-replay' required
updatedAtstring date-time required

Example response

{
  "id": "qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2"
}