data
\n[object]
A list of workflows.
attributes [required]
\nobject
Attributes of a workflow returned in a list response.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name [required]
\nstring
Name of the workflow.
published
\nboolean
Whether the workflow is published. Unpublished workflows can only be run manually. Automatic triggers such as Schedule do not fire until the workflow is published.
spec
\nobject
The spec defines what the workflow does.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The definition of StepDisplay object.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. Only required if no other trigger exists.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
id
\nstring
The workflow identifier.
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
meta
\nobject
Metadata for a List Workflows response.
page
\nobject
Pagination metadata for a List Workflows response.
totalCount
\nint64
The total number of workflows in the organization.
totalFilteredCount
\nint64
The total number of workflows matching the applied filters.
data
\n[object]
A list of workflows.
attributes [required]
\nobject
Attributes of a workflow returned in a list response.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name [required]
\nstring
Name of the workflow.
published
\nboolean
Whether the workflow is published. Unpublished workflows can only be run manually. Automatic triggers such as Schedule do not fire until the workflow is published.
spec
\nobject
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run. This list is empty for a terminal step.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
id
\nstring
The workflow identifier.
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
meta
\nobject
Metadata for a List Workflows response.
page
\nobject
Pagination metadata for a List Workflows response.
totalCount
\nint64
The total number of workflows in the organization.
totalFilteredCount
\nint64
The total number of workflows matching the applied filters.
data [required]
\nobject
Data related to the workflow.
attributes [required]
\nobject
The definition of WorkflowDataAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name [required]
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
\nobject
The spec defines what the workflow does.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The definition of StepDisplay object.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. Only required if no other trigger exists.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data [required]
\nobject
Data related to the workflow.
attributes [required]
\nobject
The definition of WorkflowDataAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name [required]
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
\nobject
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run. This list is empty for a terminal step.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data [required]
\nobject
Data related to the workflow.
attributes [required]
\nobject
The definition of WorkflowDataAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name [required]
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
\nobject
The spec defines what the workflow does.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The definition of StepDisplay object.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. Only required if no other trigger exists.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data [required]
\nobject
Data related to the workflow.
attributes [required]
\nobject
The definition of WorkflowDataAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name [required]
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
\nobject
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run. This list is empty for a terminal step.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data
\nobject
Data related to the workflow.
attributes [required]
\nobject
The definition of WorkflowDataAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name [required]
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
\nobject
The spec defines what the workflow does.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The definition of StepDisplay object.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. Only required if no other trigger exists.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data
\nobject
Data related to the workflow.
attributes [required]
\nobject
The definition of WorkflowDataAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name [required]
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
\nobject
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run. This list is empty for a terminal step.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data
\nobject
Data related to the workflow being updated.
attributes [required]
\nobject
The definition of WorkflowDataUpdateAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec
\nobject
The spec defines what the workflow does.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The definition of StepDisplay object.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. Only required if no other trigger exists.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data
\nobject
Data related to the workflow being updated.
attributes [required]
\nobject
The definition of WorkflowDataUpdateAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec
\nobject
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run. This list is empty for a terminal step.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data [required]
\nobject
Data related to the workflow being updated.
attributes [required]
\nobject
The definition of WorkflowDataUpdateAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec
\nobject
The spec defines what the workflow does.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The definition of StepDisplay object.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\ndouble
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. Only required if no other trigger exists.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows
data [required]
\nobject
Data related to the workflow being updated.
attributes [required]
\nobject
The definition of WorkflowDataUpdateAttributes object.
createdAt
\ndate-time
When the workflow was created.
description
\nstring
Description of the workflow.
name
\nstring
Name of the workflow.
published
\nboolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec
\nobject
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
\nobject
The definition of AnnotationDisplay object.
bounds
\nobject
The definition of AnnotationDisplayBounds object.
height
\ndouble
The bounds height.
width
\ndouble
The bounds width.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
id [required]
\nstring
The Annotation id.
markdownTextAnnotation [required]
\nobject
The definition of AnnotationMarkdownTextAnnotation object.
text
\nstring
The markdownTextAnnotation text.
connectionEnvs
\n[object]
A list of connections or connection groups used in the workflow.
connectionGroups
\n[object]
The ConnectionEnv connectionGroups.
connectionGroupId [required]
\nstring
The ConnectionGroup connectionGroupId.
label [required]
\nstring
The ConnectionGroup label.
tags [required]
\n[string]
The ConnectionGroup tags.
connections
\n[object]
The ConnectionEnv connections.
connectionId [required]
\nstring
The Connection connectionId.
label [required]
\nstring
The Connection label.
env [required]
\nenum
The definition of ConnectionEnvEnv object. \nAllowed enum values: default
handle
\nstring
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
\nobject
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
\n[object]
The InputSchema parameters.
allowExtraValues
\nboolean
The InputSchemaParameters allowExtraValues.
allowedValues
\nThe InputSchemaParameters allowedValues.
defaultValue
\nThe InputSchemaParameters defaultValue.
description
\nstring
The InputSchemaParameters description.
label
\nstring
The InputSchemaParameters label.
name [required]
\nstring
The InputSchemaParameters name.
type [required]
\nenum
The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
\nobject
A list of output parameters for the workflow.
parameters
\n[object]
The OutputSchema parameters.
defaultValue
\nThe OutputSchemaParameters defaultValue.
description
\nstring
The OutputSchemaParameters description.
label
\nstring
The OutputSchemaParameters label.
name [required]
\nstring
The OutputSchemaParameters name.
type [required]
\nenum
The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
\nThe OutputSchemaParameters value.
steps
\n[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
\nstring
The unique identifier of an action.
completionGate
\nobject
Used to create conditions before running subsequent actions.
completionCondition [required]
\nobject
The definition of CompletionCondition object.
operand1 [required]
\nThe CompletionCondition operand1.
operand2
\nThe CompletionCondition operand2.
operator [required]
\nenum
The definition of CompletionConditionOperator object. \nAllowed enum values: OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULLShow 2 more
,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
connectionLabel
\nstring
The unique identifier of a connection defined in the spec.
display
\nobject
The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.
bounds
\nobject
The definition of StepDisplayBounds object.
x
\ndouble
The bounds x.
y
\ndouble
The bounds y.
errorHandlers
\n[object]
The Step errorHandlers.
fallbackStepName [required]
\nstring
The ErrorHandler fallbackStepName.
retryStrategy [required]
\nobject
The definition of RetryStrategy object.
kind [required]
\nenum
The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR
linear [required]
\nobject
The definition of RetryStrategyLinear object.
interval [required]
\nstring
The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
\nint32
The RetryStrategyLinear maxRetries.
name [required]
\nstring
Name of the step.
outboundEdges
\n[object]
A list of subsequent actions to run. This list is empty for a terminal step.
branchName [required]
\nstring
The OutboundEdge branchName.
nextStepName [required]
\nstring
The OutboundEdge nextStepName.
parameters
\n[object]
A list of inputs for an action.
name [required]
\nstring
The Parameter name.
value [required]
\nThe Parameter value.
readinessGate
\nobject
Used to merge multiple branches into a single branch.
thresholdType [required]
\nenum
The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL
triggers
\n[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Object 1
\nobject
Schema for an API-based trigger.
apiTrigger [required]
\nobject
Trigger a workflow from an API request. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 2
\nobject
Schema for an App-based trigger.
appTrigger [required]
\nobject
Trigger a workflow from an App.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 3
\nobject
Schema for a Case-based trigger.
caseTrigger [required]
\nobject
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 4
\nobject
Schema for a Change Event-based trigger.
changeEventTrigger [required]
\nobject
Trigger a workflow from a Change Event.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 5
\nobject
Schema for a Database Monitoring-based trigger.
databaseMonitoringTrigger [required]
\nobject
Trigger a workflow from Database Monitoring.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 6
\nobject
Schema for a Datastore-based trigger.
datastoreTrigger [required]
\nobject
Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 7
\nobject
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
\nobject
Trigger a workflow from a Dashboard.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 8
\nobject
Schema for a Form-based trigger.
formTrigger [required]
\nobject
Trigger a workflow from a Form.
formId
\nstring
The form UUID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 9
\nobject
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
\nobject
Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 10
\nobject
Schema for an Incident-based trigger.
incidentTrigger [required]
\nobject
Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 11
\nobject
Schema for a Monitor-based trigger.
monitorTrigger [required]
\nobject
Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for a Notebook-based trigger.
notebookTrigger [required]
\nobject
Trigger a workflow from a Notebook.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an On-Call-based trigger.
onCallTrigger [required]
\nobject
Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for a Schedule-based trigger.
scheduleTrigger [required]
\nobject
Trigger a workflow from a Schedule. The workflow must be published.
overlapBehavior
\nenum
Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED
default: EXCLUSIVE_RUN
rruleExpression [required]
\nstring
Recurrence rule expression for scheduling.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for a Security-based trigger.
securityTrigger [required]
\nobject
Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
\nobject
Defines a rate limit for a trigger.
count
\nint64
The TriggerRateLimit count.
interval
\nstring
The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for a Self Service-based trigger.
selfServiceTrigger [required]
\nobject
Trigger a workflow from Self Service.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\nobject
Schema for a Software Catalog-based trigger.
softwareCatalogTrigger [required]
\nobject
Trigger a workflow from Software Catalog.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\nobject
Schema for a Workflow-based trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
workflowTrigger [required]
\nobject
Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.
tags
\n[string]
Tags of the workflow.
updatedAt
\ndate-time
When the workflow was last updated.
webhookSecret
\nstring
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
\nstring
The workflow identifier
relationships
\nobject
The definition of WorkflowDataRelationships object.
creator
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
owner
\nobject
The definition of WorkflowUserRelationship object.
data
\nobject
The definition of WorkflowUserRelationshipData object.
id [required]
\nstring
The user identifier
type [required]
\nenum
The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users
type [required]
\nenum
The definition of WorkflowDataType object. \nAllowed enum values: workflows