Skip to content

QSTH-703 Document Rest API for QStash Label #519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

QSTH-703 Document Rest API for QStash Label #519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d99ad31
Document Rest API for QStash Label
sancar Aug 26, 2025
4c4d650
no need for documenting deprecated api
sancar Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _snippets/qstash-dlq-message-type.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,7 @@
<ResponseField name="responseBodyBase64" type="string">
The base64 encoded response body of the last failed deliver attempt if the response body contains a non-utf8 char only, empty otherwise.
</ResponseField>

<ResponseField name="label" type="string">
The label of the message assigned by the user.
</ResponseField>
4 changes: 4 additions & 0 deletions _snippets/qstash-message-type.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,8 @@

<ResponseField name="callerIP" type="string" required>
IP address of the publisher of this message.
</ResponseField>

<ResponseField name="label" type="string">
The label of the message assigned by the user.
</ResponseField>
5 changes: 4 additions & 1 deletion _snippets/workflow/workflow-dlq-message-type.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,7 @@
</ResponseField>
<ResponseField name="failureCallbackInfo" type="object">
Detailed information about the failure callback, including state, response body, response status and response headers.
</ResponseField>
</ResponseField>
<ResponseField name="label" type="string">
The label of the run assigned by the user.
</ResponseField>
4 changes: 3 additions & 1 deletion qstash/api/dlq/listMessages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ List all messages currently inside the DLQ
<ParamField query="order" type="string">
The sorting order of DLQ messages by timestamp. Valid values are "earliestFirst" and "latestFirst". The default is "earliestFirst".
</ParamField>

<ResponseField name="label" type="string">
Filter DLQ messages by the label of the message assigned by the user.
</ResponseField>
## Response

<ResponseField name="cursor" type="string">
Expand Down
6 changes: 6 additions & 0 deletions qstash/api/logs/list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ authMethod: "bearer"
The sorting order of logs by timestamp. Valid values are "earliestFirst" and "latestFirst". The default is "latestFirst".
</ParamField>

<ResponseField name="label" type="string">
Filter event by the label of the message assigned by the user.
</ResponseField>
## Response


Expand Down Expand Up @@ -160,6 +163,9 @@ If no cursor is returned, you have reached the end of the logs.
<ResponseField name="retryDelayExpression" type="string">
The mathematical expression used to calculate delay between retry attempts. If not set, [the default backoff](/qstash/features/retry) is used.
</ResponseField>
<ResponseField name="label" type="string">
The label of the message assigned by the user.
</ResponseField>
</Expandable>
</ResponseField>

Expand Down
4 changes: 3 additions & 1 deletion workflow/rest/dlq/list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ List all failed workflow runs currently inside the Dead Letter Queue.
<ParamField query="count" type="number">
The number of workflow runs to return. Default and maximum is 100.
</ParamField>

<ResponseField name="label" type="string">
Filter workflow run by the label assigned by the user.
</ResponseField>
## Response

<ResponseField name="cursor" type="string">
Expand Down
8 changes: 8 additions & 0 deletions workflow/rest/runs/logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ To uniquely identify a single workflow run, include the `workflowCreatedAt` time
The number of workflow runs to return. Default and max is 10.
</ParamField>

<ResponseField name="label" type="string">
Filter workflow run by the label assigned by the user.
</ResponseField>

## Response

<ResponseField name="cursor" type="string">
Expand Down Expand Up @@ -95,6 +99,10 @@ To uniquely identify a single workflow run, include the `workflowCreatedAt` time
The Unix timestamp (in milliseconds) when the workflow run was completed, if applicable.
</ResponseField>

<ResponseField name="label" type="string">
The label of the run assigned by the user on trigger.
</ResponseField>

<ResponseField name="failureFunction" type="FailureFunction">
The details of the failure callback message, if a failure function was defined for the workflow.

Expand Down