You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dsl.md
+28-22Lines changed: 28 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -118,31 +118,37 @@ Runtimes are expected to publish these events upon state changes. While using th
118
118
119
119
##### Workflow Lifecycle Events
120
120
121
-
| Type | Data | Description |
122
-
|:----:|:----:|:------------|
123
-
| <pre>`io.serverlessworkflow.workflow.started.v1`</pre> |[`workflowStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-started-event)| Notifies about the start of a workflow. |
124
-
| <pre>`io.serverlessworkflow.workflow.suspended.v1`</pre> |[`workflowSupsendedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-suspended-event)| Notifies about suspending a workflow execution. |
125
-
| <pre>`io.serverlessworkflow.workflow.resumed.v1`</pre> |[`workflowResumedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-resumed-event)| Notifies about resuming a workflow execution. |
126
-
| <pre>`io.serverlessworkflow.workflow.correlation-started.v1`</pre> |[`workflowCorrelationStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-correlation-started-event)| Notifies about a workflow starting to correlate events. |
127
-
| <pre>`io.serverlessworkflow.workflow.correlation-completed.v1`</pre> |[`workflowCorrelationCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-correlation-completed-event)| Notifies about a workflow completing an event correlation. |
128
-
| <pre>`io.serverlessworkflow.workflow.cancelled.v1`</pre> |[`workflowCancelledEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-cancelled-event)| Notifies about the cancellation of a workflow execution. |
129
-
| <pre>`io.serverlessworkflow.workflow.faulted.v1`</pre> |[`workflowFaultedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-faulted-event)| Notifies about a workflow being faulted. |
130
-
| <pre>`io.serverlessworkflow.workflow.completed.v1`</pre> |[`workflowCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-completed-event)| Notifies about the completion of a workflow execution. |
131
-
| <pre>`io.serverlessworkflow.workflow.status-changed.v1`</pre> |[`workflowStatusChangedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-status-changed-event)| Notifies about the change of a workflow's status phase. |
121
+
| Type | Data | Required | Description |
122
+
|:----:|:----:|:--------:|:------------|
123
+
| <pre>`io.serverlessworkflow.workflow.started.v1`</pre> |[`workflowStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-started-event)|`yes`| Notifies about the start of a workflow. |
124
+
| <pre>`io.serverlessworkflow.workflow.suspended.v1`</pre> |[`workflowSupsendedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-suspended-event)|`yes`| Notifies about suspending a workflow execution. |
125
+
| <pre>`io.serverlessworkflow.workflow.resumed.v1`</pre> |[`workflowResumedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-resumed-event)|`yes`| Notifies about resuming a workflow execution. |
126
+
| <pre>`io.serverlessworkflow.workflow.correlation-started.v1`</pre> |[`workflowCorrelationStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-correlation-started-event)|`yes`| Notifies about a workflow starting to correlate events. |
127
+
| <pre>`io.serverlessworkflow.workflow.correlation-completed.v1`</pre> |[`workflowCorrelationCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-correlation-completed-event)|`yes`| Notifies about a workflow completing an event correlation. |
128
+
| <pre>`io.serverlessworkflow.workflow.cancelled.v1`</pre> |[`workflowCancelledEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-cancelled-event)|`yes`| Notifies about the cancellation of a workflow execution. |
129
+
| <pre>`io.serverlessworkflow.workflow.faulted.v1`</pre> |[`workflowFaultedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-faulted-event)|`yes`| Notifies about a workflow being faulted. |
130
+
| <pre>`io.serverlessworkflow.workflow.completed.v1`</pre> |[`workflowCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-completed-event)|`yes`|Notifies about the completion of a workflow execution. |
131
+
| <pre>`io.serverlessworkflow.workflow.status-changed.v1`</pre> |[`workflowStatusChangedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#workflow-status-changed-event)|`no`|Notifies about the change of a workflow's status phase. |
132
+
133
+
> [!NOTE]
134
+
> The `io.serverlessworkflow.workflow.status-changed.v1` event is an optional convenience event that notifies consumers solely about a workflow’s status changes, without carrying extra data. It is typically used by consumers who only need to track or report status updates (and not details like faults or outputs). Its use is optional because it requires runtimes to publish an additional event for each necessary lifecycle change.
132
135
133
136
##### Task Lifecycle Events
134
137
135
-
| Type | Data | Description |
136
-
|:----:|:----:|:------------|
137
-
| <pre>`io.serverlessworkflow.task.created.v1`</pre> |[`taskCreatedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-created-event)| Notifies about the creation of a task. |
138
-
| <pre>`io.serverlessworkflow.task.started.v1`</pre> |[`taskStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-started-event)| Notifies about the start of a task. |
139
-
| <pre>`io.serverlessworkflow.task.suspended.v1`</pre> |[`taskSuspendedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-suspended-event)| Notifies about suspending a task's execution. |
140
-
| <pre>`io.serverlessworkflow.task.resumed.v1`</pre> |[`taskResumedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-resumed-event)| Notifies about resuming a task's execution. |
141
-
| <pre>`io.serverlessworkflow.task.retried.v1`</pre> |[`taskRetriedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-retried-event)| Notifies about retrying a task's execution. |
142
-
| <pre>`io.serverlessworkflow.task.cancelled.v1`</pre> |[`taskCancelledEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-cancelled-event)| Notifies about the cancellation of a task's execution. |
143
-
| <pre>`io.serverlessworkflow.task.faulted.v1`</pre> |[`taskFaultedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-faulted-event)| Notifies about a task being faulted. |
144
-
| <pre>`io.serverlessworkflow.task.completed.v1`</pre> |[`taskCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-completed-event)| Notifies about the completion of a task's execution. |
145
-
| <pre>`io.serverlessworkflow.task.status-changed.v1`</pre> |[`taskStatusChangedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-status-changed-event)| Notifies about the change of a task's status phase. |
138
+
| Type | Data | Required | Description |
139
+
|:----:|:----:|:--------:|:------------|
140
+
| <pre>`io.serverlessworkflow.task.created.v1`</pre> |[`taskCreatedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-created-event)|`yes`| Notifies about the creation of a task. |
141
+
| <pre>`io.serverlessworkflow.task.started.v1`</pre> |[`taskStartedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-started-event)|`yes`| Notifies about the start of a task. |
142
+
| <pre>`io.serverlessworkflow.task.suspended.v1`</pre> |[`taskSuspendedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-suspended-event)|`yes`| Notifies about suspending a task's execution. |
143
+
| <pre>`io.serverlessworkflow.task.resumed.v1`</pre> |[`taskResumedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-resumed-event)|`yes`| Notifies about resuming a task's execution. |
144
+
| <pre>`io.serverlessworkflow.task.retried.v1`</pre> |[`taskRetriedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-retried-event)|`yes`| Notifies about retrying a task's execution. |
145
+
| <pre>`io.serverlessworkflow.task.cancelled.v1`</pre> |[`taskCancelledEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-cancelled-event)|`yes`| Notifies about the cancellation of a task's execution. |
146
+
| <pre>`io.serverlessworkflow.task.faulted.v1`</pre> |[`taskFaultedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-faulted-event)|`yes`| Notifies about a task being faulted. |
147
+
| <pre>`io.serverlessworkflow.task.completed.v1`</pre> |[`taskCompletedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-completed-event)|`yes`| Notifies about the completion of a task's execution. |
148
+
| <pre>`io.serverlessworkflow.task.status-changed.v1`</pre> |[`taskStatusChangedEvent`](https://github.com/serverlessworkflow/specification/blob/main/dsl-reference.md#task-status-changed-event)|`no`| Notifies about the change of a task's status phase. |
149
+
150
+
> [!NOTE]
151
+
> The `io.serverlessworkflow.task.status-changed.v1` event is an optional convenience event that notifies consumers solely about a workflow’s status changes, without carrying extra data. It is typically used by consumers who only need to track or report status updates (and not details like faults or outputs). Its use is optional because it requires runtimes to publish an additional event for each necessary lifecycle change.
0 commit comments