SVsvix
Endpoint

Bulk Replay Messages

Changed on

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

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay
  • Auth
    HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier
endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

Headers

idempotency-keystring

The request's idempotency key

Request body

channelstring nullable
eventTypesstring[] nullable
sincestring date-time required
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
tagstring nullable
untilstring date-time nullable

Example request

{
  "channel": "project_1337",
  "eventTypes": [
    "user.signup"
  ],
  "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"
}

Changes