Skip to content

Two small updates on Workflow Rest API #520

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

Two small updates on Workflow Rest API #520

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
d222ffe
QSTH-698 Doc nextDeliveryTime for Workflow Step Retries
sancar Aug 26, 2025
0679ade
QSTH-715 Doc WorkflowInfo on NotifyResponse
sancar Aug 26, 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
2 changes: 2 additions & 0 deletions workflow/basics/context.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,8 @@ export type NotifyResponse = {
waiter: Waiter;
messageId: string;
error: string;
workflowRunId: string;
workflowCreatedAt: number;
};
```

Expand Down
4 changes: 4 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 @@ -251,6 +251,10 @@ To uniquely identify a single workflow run, include the `workflowCreatedAt` time
The unix timestamp in milliseconds when the message associated with this step has created.
</ResponseField>

<ResponseField name="nextDeliveryTime" type="number">
The unix timestamp in milliseconds when this step will be retried.
This is set only when the step state is `STEP_RETRY`
</ResponseField>

**The following fields are set only when a specific type of step is executing. These fields are not available for all step types.**

Expand Down
7 changes: 5 additions & 2 deletions workflow/rest/runs/notify.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ Notify workflows waiting for an event to resume them. See [our documentation to

## Response

The response contains a list of notified waiter objects and id of the message sent as a result of the notify request.
The response contains a list of
- notified waiter objects,
- id of the message sent,
- workflowRunId and workflowCreatedAt fields for the related workflow runs, as a result of the notify request.

```typescript
type NotifyResponse = { waiter: Waiter, messageId: string }[]
type NotifyResponse = { waiter: Waiter, messageId: string, workflowRunId: string, workflowCreatedAt: number}[]
```

More information about the `Waiter` object:
Expand Down