List Events
List all events that happened, such as message creation or delivery
Request
By providing a cursor you can paginate through all of the events.
Filter events by message id.
Filter events by state
Filter events by url.
Filter events by URL Group (topic) name.
Filter events by schedule id.
Filter events by queue name.
Filter events by starting date, in milliseconds (Unix timestamp). This is inclusive.
Filter events by ending date, in milliseconds (Unix timestamp). This is inclusive.
The number of events to return. Default and max is 1000.
The sorting order of events by timestamp. Valid values are “earliestFirst” and “latestFirst”. The default is “latestFirst”.
Response
A cursor which you can use in subsequent requests to paginate through all events. If no cursor is returned, you have reached the end of the events.
Timestamp of this log entry, in milliseconds
The associated message id
The headers of the message.
Base64 encoded body of the message.
The current state of the message at this point in time.
| Value | Description |
|---|---|
CREATED | The message has been accepted and stored in QStash |
ACTIVE | The task is currently being processed by a worker. |
RETRY | The task has been scheduled to retry. |
ERROR | The execution threw an error and the task is waiting to be retried or failed. |
DELIVERED | The message was successfully delivered. |
FAILED | The task has errored too many times or encountered an error that it cannot recover from. |
CANCEL_REQUESTED | The cancel request from the user is recorded. |
CANCELLED | The cancel request from the user is honored. |
An explanation what went wrong
The next scheduled time of the message. (Unix timestamp in milliseconds)
The destination url
The name of the URL Group (topic) if this message was sent through a topic
The name of the endpoint if this message was sent through a URL Group
The scheduleId of the message if the message is triggered by a schedule
The name of the queue if this message is enqueued on a queue
Was this page helpful?