Workflows Management API reference
Complete reference documentation for the Workflows resource.
Workflows
#To define a logical flow for your notifications, you create a workflow consisting of steps. Workflow steps can be functions or channels, and can have conditional logic that determines whether to execute that step when the workflow is triggered.
You can retrieve, update, or create a workflow as well as list all workflows in a given environment. Workflows are identified by their unique workflow key.
List workflows
#Returns a paginated list of workflows available in a given environment. The workflows are returned alphabetically by key.
Endpoint
Query parameters
The environment slug.
The slug of a branch to use. This option can only be used when environment is "development".
The cursor to fetch entries after.
The cursor to fetch entries before.
The number of entries to fetch per-page.
Whether to annotate the resource. Only used in the Knock CLI.
Whether to hide uncommitted changes. When true, only committed changes will be returned. When false, both committed and uncommitted changes will be returned.
Returns
A paginated list of Workflow. Contains a list of entries and page information.
A list of entries.
Whether the workflow is active in the current environment. (read-only).
A list of categories that the workflow belongs to.
A conditions object that describes one or more conditions to be met for the workflow to be executed. (optional).
The timestamp of when the workflow was created. (read-only).
The timestamp of when the workflow was deleted. (read-only).
An arbitrary string attached to a workflow object. Useful for adding notes about the workflow for internal purposes. Maximum of 280 characters allowed.
The slug of the environment in which the workflow exists. (read-only).
The unique key string for the workflow object. Must be at minimum 3 characters and at maximum 255 characters in length. Must be in the format of ^[a-z0-9_-]+$.
A name for the workflow. Must be at maximum 255 characters in length.
A map of workflow settings.
Whether the workflow is commercial. Defaults to false.
Whether to ignore recipient preferences for a given type of notification. If true, will send for every channel in the workflow even if the recipient has opted out of a certain kind. Defaults to false.
The SHA hash of the workflow data. (read-only).
A JSON schema for the expected structure of the workflow trigger's data payload (available in templates as {{ data.field_name }}). Used to validate trigger requests. Read more in the docs.
The frequency at which the workflow should be triggered. One of: once_per_recipient, once_per_recipient_per_tenant, every_trigger. Defaults to every_trigger. Read more in docs.
The timestamp of when the workflow was last updated. (read-only).
Whether the workflow and its steps are in a valid state. (read-only).
The information about a paginated result.
The cursor to fetch entries after. Will only be present if there are more entries to fetch.
The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.
The number of entries to fetch per-page.
Get a workflow
#Retrieve a workflow by its key in a given environment.
Endpoint
Path parameters
The key of the workflow to retrieve.
Query parameters
The environment slug.
The slug of a branch to use. This option can only be used when environment is "development".
Whether to annotate the resource. Only used in the Knock CLI.
Whether to hide uncommitted changes. When true, only committed changes will be returned. When false, both committed and uncommitted changes will be returned.
Returns
A workflow object.
Whether the workflow is active in the current environment. (read-only).
A list of categories that the workflow belongs to.
A conditions object that describes one or more conditions to be met for the workflow to be executed. (optional).
The timestamp of when the workflow was created. (read-only).
Information about the user who created the workflow. Only included in detailed views. (read-only).
The timestamp of when the workflow was deleted. (read-only).
An arbitrary string attached to a workflow object. Useful for adding notes about the workflow for internal purposes. Maximum of 280 characters allowed.
The slug of the environment in which the workflow exists. (read-only).
The unique key string for the workflow object. Must be at minimum 3 characters and at maximum 255 characters in length. Must be in the format of ^[a-z0-9_-]+$.
A name for the workflow. Must be at maximum 255 characters in length.
A map of workflow settings.
Whether the workflow is commercial. Defaults to false.
Whether to ignore recipient preferences for a given type of notification. If true, will send for every channel in the workflow even if the recipient has opted out of a certain kind. Defaults to false.
The SHA hash of the workflow data. (read-only).
A JSON schema for the expected structure of the workflow trigger's data payload (available in templates as {{ data.field_name }}). Used to validate trigger requests. Read more in the docs.
The frequency at which the workflow should be triggered. One of: once_per_recipient, once_per_recipient_per_tenant, every_trigger. Defaults to every_trigger. Read more in docs.
The timestamp of when the workflow was last updated. (read-only).
Information about the user who last updated the workflow. Only included in detailed views. (read-only).
Whether the workflow and its steps are in a valid state. (read-only).
Upsert a workflow
#Updates a workflow of a given key, or creates a new one if it does not yet exist.
Note: this endpoint only operates on workflows in the development environment.
Endpoint
Path parameters
The key of the workflow.
Query parameters
The environment slug.
The slug of a branch to use. This option can only be used when environment is "development".
Whether to annotate the resource. Only used in the Knock CLI.
Whether to commit the resource at the same time as modifying it.
The message to commit the resource with, only used if commit is true.
Request body
A workflow request for upserting a workflow.
A list of categories that the workflow belongs to.
A conditions object that describes one or more conditions to be met for the workflow to be executed. (optional).
An arbitrary string attached to a workflow object. Useful for adding notes about the workflow for internal purposes. Maximum of 280 characters allowed.
A name for the workflow. Must be at maximum 255 characters in length.
A map of workflow settings.
Whether the workflow is commercial. Defaults to false.
Whether to ignore recipient preferences for a given type of notification. If true, will send for every channel in the workflow even if the recipient has opted out of a certain kind. Defaults to false.
A JSON schema for the expected structure of the workflow trigger's data payload (available in templates as {{ data.field_name }}). Used to validate trigger requests. Read more in the docs.
The frequency at which the workflow should be triggered. One of: once_per_recipient, once_per_recipient_per_tenant, every_trigger. Defaults to every_trigger. Read more in docs.
Returns
Wraps the Workflow response under the workflow key.
A workflow object. Read more in the docs.
Whether the workflow is active in the current environment. (read-only).
A list of categories that the workflow belongs to.
A conditions object that describes one or more conditions to be met for the workflow to be executed. (optional).
The timestamp of when the workflow was created. (read-only).
The timestamp of when the workflow was deleted. (read-only).
An arbitrary string attached to a workflow object. Useful for adding notes about the workflow for internal purposes. Maximum of 280 characters allowed.
The slug of the environment in which the workflow exists. (read-only).
The unique key string for the workflow object. Must be at minimum 3 characters and at maximum 255 characters in length. Must be in the format of ^[a-z0-9_-]+$.
A name for the workflow. Must be at maximum 255 characters in length.
A map of workflow settings.
Whether the workflow is commercial. Defaults to false.
Whether to ignore recipient preferences for a given type of notification. If true, will send for every channel in the workflow even if the recipient has opted out of a certain kind. Defaults to false.
The SHA hash of the workflow data. (read-only).
A JSON schema for the expected structure of the workflow trigger's data payload (available in templates as {{ data.field_name }}). Used to validate trigger requests. Read more in the docs.
The frequency at which the workflow should be triggered. One of: once_per_recipient, once_per_recipient_per_tenant, every_trigger. Defaults to every_trigger. Read more in docs.
The timestamp of when the workflow was last updated. (read-only).
Whether the workflow and its steps are in a valid state. (read-only).
Activate a workflow
#Activates (or deactivates) a workflow in a given environment. Read more in the docs.
Note: This immediately enables or disables a workflow in a given environment without needing to go through environment promotion.
Endpoint
Path parameters
The key of the workflow.
Query parameters
The environment slug.
The slug of a branch to use. This option can only be used when environment is "development".
Request body
Whether to activate or deactivate the workflow. Set to true by default, which will activate the workflow.
Returns
Wraps the Workflow response under the workflow key.
A workflow object. Read more in the docs.
Whether the workflow is active in the current environment. (read-only).
A list of categories that the workflow belongs to.
A conditions object that describes one or more conditions to be met for the workflow to be executed. (optional).
The timestamp of when the workflow was created. (read-only).
The timestamp of when the workflow was deleted. (read-only).
An arbitrary string attached to a workflow object. Useful for adding notes about the workflow for internal purposes. Maximum of 280 characters allowed.
The slug of the environment in which the workflow exists. (read-only).
The unique key string for the workflow object. Must be at minimum 3 characters and at maximum 255 characters in length. Must be in the format of ^[a-z0-9_-]+$.
A name for the workflow. Must be at maximum 255 characters in length.
A map of workflow settings.
Whether the workflow is commercial. Defaults to false.
Whether to ignore recipient preferences for a given type of notification. If true, will send for every channel in the workflow even if the recipient has opted out of a certain kind. Defaults to false.
The SHA hash of the workflow data. (read-only).
A JSON schema for the expected structure of the workflow trigger's data payload (available in templates as {{ data.field_name }}). Used to validate trigger requests. Read more in the docs.
The frequency at which the workflow should be triggered. One of: once_per_recipient, once_per_recipient_per_tenant, every_trigger. Defaults to every_trigger. Read more in docs.
The timestamp of when the workflow was last updated. (read-only).
Whether the workflow and its steps are in a valid state. (read-only).
Run a workflow
#Runs the latest version of a committed workflow in a given environment using the params provided.
Endpoint
Path parameters
The key of the workflow.
Query parameters
The environment slug.
The slug of a branch to use. This option can only be used when environment is "development".
Request body
The actor to reference in the the workflow run.
A key to cancel the workflow run.
A map of data to be used in the workflow run. The structure should conform to the workflow's trigger_data_json_schema if one is defined. Available in templates as {{ data.field_name }}. See trigger data validation docs.
A list of recipients to run the workflow for.
The tenant to associate the workflow run with. Must not contain whitespace.
Returns
A response to a run workflow request.
The ID of the workflow run.
Validate a workflow
#Validates a workflow payload without persisting it. Some read-only fields will be empty as they are generated by the system when persisted.
Note: Validating a workflow is only done in the development environment context.
Endpoint
Path parameters
The key of the workflow.
Query parameters
The environment slug.
The slug of a branch to use. This option can only be used when environment is "development".
Request body
A workflow request for upserting a workflow.
A list of categories that the workflow belongs to.
A conditions object that describes one or more conditions to be met for the workflow to be executed. (optional).
An arbitrary string attached to a workflow object. Useful for adding notes about the workflow for internal purposes. Maximum of 280 characters allowed.
A name for the workflow. Must be at maximum 255 characters in length.
A map of workflow settings.
Whether the workflow is commercial. Defaults to false.
Whether to ignore recipient preferences for a given type of notification. If true, will send for every channel in the workflow even if the recipient has opted out of a certain kind. Defaults to false.
A JSON schema for the expected structure of the workflow trigger's data payload (available in templates as {{ data.field_name }}). Used to validate trigger requests. Read more in the docs.
The frequency at which the workflow should be triggered. One of: once_per_recipient, once_per_recipient_per_tenant, every_trigger. Defaults to every_trigger. Read more in docs.
Returns
Wraps the Workflow response under the workflow key.
A workflow object. Read more in the docs.
Whether the workflow is active in the current environment. (read-only).
A list of categories that the workflow belongs to.
A conditions object that describes one or more conditions to be met for the workflow to be executed. (optional).
The timestamp of when the workflow was created. (read-only).
The timestamp of when the workflow was deleted. (read-only).
An arbitrary string attached to a workflow object. Useful for adding notes about the workflow for internal purposes. Maximum of 280 characters allowed.
The slug of the environment in which the workflow exists. (read-only).
The unique key string for the workflow object. Must be at minimum 3 characters and at maximum 255 characters in length. Must be in the format of ^[a-z0-9_-]+$.
A name for the workflow. Must be at maximum 255 characters in length.
A map of workflow settings.
Whether the workflow is commercial. Defaults to false.
Whether to ignore recipient preferences for a given type of notification. If true, will send for every channel in the workflow even if the recipient has opted out of a certain kind. Defaults to false.
The SHA hash of the workflow data. (read-only).
A JSON schema for the expected structure of the workflow trigger's data payload (available in templates as {{ data.field_name }}). Used to validate trigger requests. Read more in the docs.
The frequency at which the workflow should be triggered. One of: once_per_recipient, once_per_recipient_per_tenant, every_trigger. Defaults to every_trigger. Read more in docs.
The timestamp of when the workflow was last updated. (read-only).
Whether the workflow and its steps are in a valid state. (read-only).
Steps
#Methods that operate on the individual steps within a workflow. Steps are referenced by their ref, which is unique within a workflow.
Preview a workflow template
#Generates a rendered template for a given channel step in a workflow.
Endpoint
Path parameters
The key of the workflow.
The reference key of the channel step in the workflow to preview.
Query parameters
The environment slug.
The slug of a branch to use. This option can only be used when environment is "development".
Request body
The actor to reference in the the workflow run.
The data to pass to the workflow template for rendering.
A recipient reference, used when referencing a recipient by either their ID (for a user), or by a reference for an object.
The tenant to associate the workflow with. Must not contain whitespace.
Returns
A response to a preview workflow template request.
The content type of the preview.
The result of the preview.
The rendered template, ready to be previewed.
Condition
#A condition to be evaluated.
Attributes
The argument to be evaluated. Arguments can be either static values or dynamic properties. Static values will always be JSON decoded so will support strings, lists, objects, numbers, and booleans. Dynamic values should be path expressions.
The operator to use in the evaluation of the condition.
The variable to be evaluated. Variables can be either static values or dynamic properties. Static values will always be JSON decoded so will support strings, lists, objects, numbers, and booleans. Dynamic values should be path expressions.
ConditionGroup
#A group of conditions to be evaluated.
Attributes
A group of conditions to be evaluated.
Duration
#A duration of time, represented as a unit and a value.
Attributes
The unit of time.
The value of the duration.
SendWindow
#A send window time for a notification. Describes a single day.
Attributes
The day of the week.
The start time of the send window.
The type of send window.
The end time of the send window.
Workflow
#A workflow object. Read more in the docs.
Attributes
Whether the workflow is active in the current environment. (read-only).
A list of categories that the workflow belongs to.
A conditions object that describes one or more conditions to be met for the workflow to be executed. (optional).
The timestamp of when the workflow was created. (read-only).
The timestamp of when the workflow was deleted. (read-only).
An arbitrary string attached to a workflow object. Useful for adding notes about the workflow for internal purposes. Maximum of 280 characters allowed.
The slug of the environment in which the workflow exists. (read-only).
The unique key string for the workflow object. Must be at minimum 3 characters and at maximum 255 characters in length. Must be in the format of ^[a-z0-9_-]+$.
A name for the workflow. Must be at maximum 255 characters in length.
A map of workflow settings.
Whether the workflow is commercial. Defaults to false.
Whether to ignore recipient preferences for a given type of notification. If true, will send for every channel in the workflow even if the recipient has opted out of a certain kind. Defaults to false.
The SHA hash of the workflow data. (read-only).
A JSON schema for the expected structure of the workflow trigger's data payload (available in templates as {{ data.field_name }}). Used to validate trigger requests. Read more in the docs.
The frequency at which the workflow should be triggered. One of: once_per_recipient, once_per_recipient_per_tenant, every_trigger. Defaults to every_trigger. Read more in docs.
The timestamp of when the workflow was last updated. (read-only).
Whether the workflow and its steps are in a valid state. (read-only).
WorkflowStep
#A step within a workflow. Each workflow step, regardless of its type, share a common set of core attributes (type, ref, name, description, conditions).
Attributes
A step within a workflow. Each workflow step, regardless of its type, share a common set of core attributes (type, ref, name, description, conditions).
WorkflowBatchStep
#A batch function step. Read more in the docs.
Attributes
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
The settings for the batch step.
The execution mode of the batch step. One of: accumulate or flush_leading. When set to flush_leading, the first item in the batch will be executed immediately, and the rest will be batched. See these docs for more information.
The maximum number of batch items allowed in a batch. Between: 2 and 1000.
The maximum number of batch items allowed to be rendered into a template. Between: 1 and 100. Defaults to 10.
The data property to use to batch notifications per recipient.
The order describing whether to return the first or last ten batch items in the activities variable. One of: asc or desc.
The data path to resolve the batch window. The resolved value must be an ISO-8601 timestamp.
A duration object that describes the maximum duration a batch window can be extended to from opening when using a sliding batch window.
The type of the batch window used. One of: fixed or sliding.
The type of the workflow step.
WorkflowBranchStep
#A branch function step. Read more in the docs.
Attributes
A list of workflow branches to be evaluated.
The name of the branch.
If the workflow should halt at the end of the branch. Defaults to false if not provided.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
The type of step.
WorkflowChatStep
#A chat step within a workflow. Read more in the docs.
Attributes
The key of the channel group to which the channel step will be sending a notification. Either channel_key or channel_group_key must be provided, but not both.
The key of a specific configured channel instance (e.g., 'knock-email', 'postmark', 'sendgrid-marketing') to send the notification through. Either channel_key or channel_group_key must be provided, but not both.
The type of the channel step. Always chat for chat steps.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
A list of send window objects. Must include one send window object per day of the week.
The day of the week.
The start time of the send window.
The type of send window.
The end time of the send window.
A chat template.
A JSON template for the chat notification message payload. Only present if not using the markdown body.
The markdown body of the chat template.
The summary of the chat template. Used by some chat apps in their push notifications.
The type of the workflow step.
WorkflowInAppFeedStep
#An in-app feed step within a workflow. Read more in the docs.
Attributes
The key of the channel group to which the channel step will be sending a notification. Either channel_key or channel_group_key must be provided, but not both.
The key of a specific configured channel instance (e.g., 'knock-email', 'postmark', 'sendgrid-marketing') to send the notification through. Either channel_key or channel_group_key must be provided, but not both.
The type of the channel step. Always in_app_feed for in-app feed steps.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
A list of send window objects. Must include one send window object per day of the week.
The day of the week.
The start time of the send window.
The type of send window.
The end time of the send window.
An in-app feed template.
The action buttons of the in-app feed message.
The URI for this action.
The label of the action button.
The URL to navigate to when the in-app feed is tapped. Can be omitted for multi-action templates, where the action buttons will be used instead.
The markdown body of the in-app feed.
The type of the workflow step.
WorkflowEmailStep
#An email step within a workflow. Read more in the docs.
Attributes
The key of the channel group to which the channel step will be sending a notification. Either channel_key or channel_group_key must be provided, but not both.
The key of a specific configured channel instance (e.g., 'knock-email', 'postmark', 'sendgrid-marketing') to send the notification through. Either channel_key or channel_group_key must be provided, but not both.
The category of channel for this step. Always email for email steps. This identifies the type of notification (email, sms, push, etc.) while channel_key specifies which configured provider instance to use.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
A list of send window objects. Must include one send window object per day of the week.
The day of the week.
The start time of the send window.
The type of send window.
The end time of the send window.
An email message template.
An HTML template for the email body. Required if visual_blocks is not provided. Only one of html_body or visual_blocks should be set. Supports Liquid templating with variables like {{ recipient.name }}, {{ actor.name }}, {{ vars.app_name }}, {{ data.custom_field }}, and {{ tenant.name }}. See the template variables reference for available variables.
The settings for the email template. Must be supplied with at least layout_key.
The object path in the workflow trigger's data payload to resolve attachments.Defaults to attachments.
The key of the email layout that wraps the email template. When omitted, the email template will need to define the <html> structure.
A liquid template that will be injected into the email layout above the message template content. Useful for setting variables that should be available to the email layout.
The subject of the email. Supports Liquid templating with variables like {{ recipient.name }}, {{ actor.name }}, {{ vars.app_name }}, {{ data.custom_field }}, and {{ tenant.name }}. See the template variables reference for available variables.
A text template for the email body. When omitted, the email template will be autogenerated from the html_body or visual_blocks.
The visual blocks that make up the email template. Required if html_body is not provided. Only one of html_body or visual_blocks should be set.
The type of the workflow step.
WorkflowPushStep
#A push step within a workflow. Read more in the docs.
Attributes
The key of the channel group to which the channel step will be sending a notification. Either channel_key or channel_group_key must be provided, but not both.
The key of a specific configured channel instance (e.g., 'knock-email', 'postmark', 'sendgrid-marketing') to send the notification through. Either channel_key or channel_group_key must be provided, but not both.
The type of the channel step. Always push for push steps.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
A list of send window objects. Must include one send window object per day of the week.
The day of the week.
The start time of the send window.
The type of send window.
The end time of the send window.
A push notification template.
The settings for the push template.
The delivery type of the push notification. Set as silent to send a data-only notification. When set to silent, no body will be sent.
A JSON object that overrides the payload sent to the push provider.
The body of the push notification.
The title of the push notification.
The type of the workflow step.
WorkflowSmsStep
#A SMS step within a workflow. Read more in the docs.
Attributes
The key of the channel group to which the channel step will be sending a notification. Either channel_key or channel_group_key must be provided, but not both.
The key of a specific configured channel instance (e.g., 'knock-email', 'postmark', 'sendgrid-marketing') to send the notification through. Either channel_key or channel_group_key must be provided, but not both.
The type of the channel step. Always sms for SMS steps.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
A list of send window objects. Must include one send window object per day of the week.
The day of the week.
The start time of the send window.
The type of send window.
The end time of the send window.
An SMS template.
The settings for the SMS template. Can be omitted.
The message of the SMS.
The type of the workflow step.
WorkflowWebhookStep
#A webhook step within a workflow to send an HTTP request to a generic channel. Read more in the docs.
Attributes
The key of the channel group to which the channel step will be sending a notification. Either channel_key or channel_group_key must be provided, but not both.
The key of a specific configured channel instance (e.g., 'knock-email', 'postmark', 'sendgrid-marketing') to send the notification through. Either channel_key or channel_group_key must be provided, but not both.
The type of the channel step. Always http for webhook steps.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
A list of send window objects. Must include one send window object per day of the week.
The day of the week.
The start time of the send window.
The type of send window.
The end time of the send window.
A webhook template. By default, a webhook step will use the request settings you configured in your webhook channel. You can override this as you see fit on a per-step basis.
The body of the request. Only used for POST or PUT requests.
A list of key-value pairs for the request headers. Each object should contain key and value fields with string values.
The key of the header.
The value of the header.
The HTTP method of the webhook.
A list of key-value pairs for the request query params. Each object should contain key and value fields with string values.
The key of the query param.
The value of the query param.
The URL of the webhook.
The type of the workflow step.
WorkflowDelayStep
#A delay function step. Read more in the docs.
Attributes
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
The settings for the delay step. Both fields can be set to compute a delay where delay_for is an offset from the delay_until_field_path.
A duration object that describes how long to wait before proceeding to the next step.
When set will use the path to resolve the delay into a timestamp from the property referenced
The type of the workflow step.
WorkflowFetchStep
#A fetch function step. Retrieves data from an external source and merges it into the workflow's data scope for use in later steps. Read more in the docs.
Attributes
A conditions object that describes one or more conditions to be met in order for the step to be executed.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
A request template for a fetch function step.
The body of the request. Only used for POST or PUT requests.
The headers of the request. Can be a template string or a list of key-value pairs.
The HTTP method of the request.
The query params of the request. Can be a template string or a list of key-value pairs.
The URL of the request.
The type of the workflow step.
WorkflowThrottleStep
#A throttle function step. Read more in the docs.
Attributes
A conditions object that describes one or more conditions to be met in order for the step to be executed.
An arbitrary string attached to a workflow step. Useful for adding notes about the workflow for internal purposes.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
The settings for the throttle step.
The data property to use to throttle notifications per recipient.
The maximum number of workflows to allow within the duration window. Defaults to 1.
The data path to resolve a dynamic throttle window. The resolved value must be an ISO-8601 timestamp. See more in the docs.
The type of the workflow step.
WorkflowTriggerWorkflowStep
#A workflow trigger function step. Read more in the docs.
Attributes
A description for the workflow step.
A name for the workflow step.
The reference key of the workflow step. Must be unique per workflow.
The settings for the workflow trigger workflow step.
The actor to trigger the workflow with. Supports liquid.
The cancellation key to trigger the workflow with. Supports liquid.
The data to be supplied to the workflow. Supports liquid.
The recipients or recipient to trigger the workflow for. Supports liquid.
The tenant to trigger the workflow with. Supports liquid.
The key of the workflow to trigger. Supports liquid.
The type of the workflow step.