Skip to content

Add link field to propagate backlink in signal and signal-with-start responses#761

Open
long-nt-tran wants to merge 1 commit intotemporalio:masterfrom
long-nt-tran:signals-backlink-api
Open

Add link field to propagate backlink in signal and signal-with-start responses#761
long-nt-tran wants to merge 1 commit intotemporalio:masterfrom
long-nt-tran:signals-backlink-api

Conversation

@long-nt-tran
Copy link
Copy Markdown

@long-nt-tran long-nt-tran commented Apr 9, 2026

What changed?

Added link fields on SignalWorkflowExecutionResponse and SignalWithStartWorkflowExecutionRequest. I think a singular link should suffice but if reviewers feel otherwise (especially w.r.t. SignalWithStartWorkflowExecutionRequest) let me know.

Why?

To propagate backlinks on signal and signal-with-start executions back to the caller.

Breaking changes

Not a breaking change (unused field)

Server PR

temporalio/temporal#9897

// Link to be associated with the WorkflowExecutionSignaled event.
// Added on the response to propagate the backlink.
temporal.api.common.v1.Link signal_link = 3;
// Workflow start link to be associated with the WorkflowExecutionStarted event.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be propagated back to the caller if the workflow was already started? Seems like that would be confusing. I would call out the behavior in the docstring.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it should behave like the workflow event link on a normal start workflow, so link to the start if the workflow is started, link to the workflow options update if a callback was attached after the workflow was started.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commenting for posterity: chatted w/ both offline and we decided to add this in a later PR

@long-nt-tran long-nt-tran force-pushed the signals-backlink-api branch from 5c99d1b to 168fcbb Compare April 10, 2026 22:48
Copy link
Copy Markdown
Member

@bergundy bergundy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with a small comment.

@long-nt-tran long-nt-tran force-pushed the signals-backlink-api branch from 168fcbb to c7d4e90 Compare April 10, 2026 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants