Skip to content

Add links and callbacks support for standalone activity #759

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

Merged
fretz12 merged 10 commits into from
Apr 10, 2026
Merged

Add links and callbacks support for standalone activity #759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
42e3e05
Add start delay, callbacks, and links to StartActivityExecutionRequest
fretz12 Apr 3, 2026
507bf79
Fix proto numbering
fretz12 Apr 7, 2026
2f05ad9
Update temporal/api/workflowservice/v1/request_response.proto
fretz12 Apr 7, 2026
de1c70f
Update temporal/api/activity/v1/message.proto
fretz12 Apr 7, 2026
bb77190
Update openapi
fretz12 Apr 7, 2026
f0deaf5
Address PR comments
fretz12 Apr 7, 2026
05c3da9
Address PR comments
fretz12 Apr 10, 2026
2bc9df1
Update openapi
fretz12 Apr 10, 2026
c11d581
Refactored callback info to a shared message
fretz12 Apr 10, 2026
4f01fa3
Changed callback info field name
fretz12 Apr 10, 2026
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
228 changes: 175 additions & 53 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9041,13 +9041,9 @@
}
},
"definitions": {
"CallbackInfoTrigger": {
"CallbackInfoActivityClosed": {
"type": "object",
"properties": {
"workflowClosed": {
"$ref": "#/definitions/CallbackInfoWorkflowClosed"
}
}
"description": "Trigger for when the activity is closed."
},
"CallbackInfoWorkflowClosed": {
"type": "object",
Expand Down Expand Up @@ -9156,6 +9152,21 @@
},
"description": "Target a worker polling on a Nexus task queue in a specific namespace."
},
"LinkActivity": {
"type": "object",
"properties": {
"namespace": {
"type": "string"
},
"activityId": {
"type": "string"
},
"runId": {
"type": "string"
}
},
"description": "A link to an activity."
},
"LinkBatchJob": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -10437,6 +10448,22 @@
"priority": {
"$ref": "#/definitions/v1Priority",
"description": "Priority metadata."
},
"completionCallbacks": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1Callback"
},
"description": "Callbacks to be called by the server when this activity reaches a terminal state.\nCallback addresses must be whitelisted in the server's dynamic configuration."
},
"links": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/apiCommonV1Link"
},
"description": "Links to be associated with the activity. Callbacks may also have associated links;\nlinks already included with a callback should not be duplicated here."
}
}
},
Expand Down Expand Up @@ -11084,6 +11111,123 @@
},
"description": "Used to validate the compute config without attaching it to a Worker Deployment Version."
},
"apiActivityV1CallbackInfo": {
"type": "object",
"properties": {
"trigger": {
"$ref": "#/definitions/apiActivityV1CallbackInfoTrigger",
"description": "Trigger for this callback."
},
"info": {
"$ref": "#/definitions/apiCallbackV1CallbackInfo",
"description": "Common callback info."
}
},
"description": "CallbackInfo contains the state of an attached activity callback."
},
"apiActivityV1CallbackInfoTrigger": {
"type": "object",
"properties": {
"activityClosed": {
"$ref": "#/definitions/CallbackInfoActivityClosed"
}
}
},
"apiCallbackV1CallbackInfo": {
"type": "object",
"properties": {
"callback": {
"$ref": "#/definitions/v1Callback",
"description": "Information on how this callback should be invoked (e.g. its URL and type)."
},
"registrationTime": {
"type": "string",
"format": "date-time",
"description": "The time when the callback was registered."
},
"state": {
"$ref": "#/definitions/v1CallbackState",
"description": "The current state of the callback."
},
"attempt": {
"type": "integer",
"format": "int32",
"description": "The number of attempts made to deliver the callback.\nThis number represents a minimum bound since the attempt is incremented after the callback request completes."
},
"lastAttemptCompleteTime": {
"type": "string",
"format": "date-time",
"description": "The time when the last attempt completed."
},
"lastAttemptFailure": {
"$ref": "#/definitions/v1Failure",
"description": "The last attempt's failure, if any."
},
"nextAttemptScheduleTime": {
"type": "string",
"format": "date-time",
"description": "The time when the next attempt is scheduled."
},
"blockedReason": {
"type": "string",
"description": "If the state is BLOCKED, blocked reason provides additional information."
}
},
"description": "Common callback information. Specific CallbackInfo messages should embed this and may include additional fields."
},
"apiWorkflowV1CallbackInfo": {
"type": "object",
"properties": {
"callback": {
"$ref": "#/definitions/v1Callback",
"description": "Information on how this callback should be invoked (e.g. its URL and type)."
},
"trigger": {
"$ref": "#/definitions/apiWorkflowV1CallbackInfoTrigger",
"description": "Trigger for this callback."
},
"registrationTime": {
"type": "string",
"format": "date-time",
"description": "The time when the callback was registered."
},
"state": {
"$ref": "#/definitions/v1CallbackState"
},
"attempt": {
"type": "integer",
"format": "int32",
"description": "The number of attempts made to deliver the callback.\nThis number represents a minimum bound since the attempt is incremented after the callback request completes."
},
"lastAttemptCompleteTime": {
"type": "string",
"format": "date-time",
"description": "The time when the last attempt completed."
},
"lastAttemptFailure": {
"$ref": "#/definitions/v1Failure",
"description": "The last attempt's failure, if any."
},
"nextAttemptScheduleTime": {
"type": "string",
"format": "date-time",
"description": "The time when the next attempt is scheduled."
},
"blockedReason": {
"type": "string",
"description": "If the state is BLOCKED, blocked reason provides additional information."
}
},
"description": "CallbackInfo contains the state of an attached workflow callback."
},
"apiWorkflowV1CallbackInfoTrigger": {
"type": "object",
"properties": {
"workflowClosed": {
"$ref": "#/definitions/CallbackInfoWorkflowClosed"
}
}
},
"protobufAny": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -11249,6 +11393,14 @@
"canceledReason": {
"type": "string",
"description": "Set if activity cancelation was requested."
},
"links": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1Link"
},
"description": "Links to related entities, such as the entity that started this activity."
}
},
"description": "Information about a standalone activity."
Expand Down Expand Up @@ -12092,51 +12244,6 @@
},
"description": "Callback to attach to various events in the system, e.g. workflow run completion."
},
"v1CallbackInfo": {
"type": "object",
"properties": {
"callback": {
"$ref": "#/definitions/v1Callback",
"description": "Information on how this callback should be invoked (e.g. its URL and type)."
},
"trigger": {
"$ref": "#/definitions/CallbackInfoTrigger",
"description": "Trigger for this callback."
},
"registrationTime": {
"type": "string",
"format": "date-time",
"description": "The time when the callback was registered."
},
"state": {
"$ref": "#/definitions/v1CallbackState"
},
"attempt": {
"type": "integer",
"format": "int32",
"description": "The number of attempts made to deliver the callback.\nThis number represents a minimum bound since the attempt is incremented after the callback request completes."
},
"lastAttemptCompleteTime": {
"type": "string",
"format": "date-time",
"description": "The time when the last attempt completed."
},
"lastAttemptFailure": {
"$ref": "#/definitions/v1Failure",
"description": "The last attempt's failure, if any."
},
"nextAttemptScheduleTime": {
"type": "string",
"format": "date-time",
"description": "The time when the next attempt is scheduled."
},
"blockedReason": {
"type": "string",
"description": "If the state is BLOCKED, blocked reason provides additional information."
}
},
"description": "CallbackInfo contains the state of an attached workflow callback."
},
"v1CallbackState": {
"type": "string",
"enum": [
Expand Down Expand Up @@ -12865,6 +12972,14 @@
"type": "string",
"format": "byte",
"description": "Token for follow-on long-poll requests. Absent only if the activity is complete."
},
"callbacks": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/apiActivityV1CallbackInfo"
},
"description": "Callbacks attached to this activity execution and their current state."
}
}
},
Expand Down Expand Up @@ -13102,7 +13217,7 @@
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1CallbackInfo"
"$ref": "#/definitions/apiWorkflowV1CallbackInfo"
}
},
"pendingNexusOperations": {
Expand Down Expand Up @@ -13684,7 +13799,7 @@
"type": "object",
"$ref": "#/definitions/v1Link"
},
"description": "Links associated with the event."
"description": "Links to related entities, such as the entity that started this event's workflow."
},
"principal": {
"$ref": "#/definitions/v1Principal",
Expand Down Expand Up @@ -13952,6 +14067,9 @@
},
"batchJob": {
"$ref": "#/definitions/LinkBatchJob"
},
"activity": {
"$ref": "#/definitions/LinkActivity"
}
},
"description": "Link can be associated with history events. It might contain information about an external entity\nrelated to the history event. For example, workflow A makes a Nexus call that starts workflow B:\nin this case, a history event in workflow A could contain a Link to the workflow started event in\nworkflow B, and vice-versa."
Expand Down Expand Up @@ -16442,6 +16560,10 @@
"started": {
"type": "boolean",
"description": "If true, a new activity was started."
},
"link": {
"$ref": "#/definitions/v1Link",
"description": "Link to the started activity."
}
}
},
Expand Down
Loading
Loading