ecs:ListClusters).data
\nobject
Data for detaching security findings from their case.
relationships
\nobject
Relationships detaching security findings from their case.
findings [required]
\nobject
Security findings to detach from their case.
data
\n[object]
Array of security finding data objects.
id [required]
\nstring
Unique identifier of the security finding.
type [required]
\nenum
Security findings resource type. \nAllowed enum values: findings
default: findings
type [required]
\nenum
Cases resource type. \nAllowed enum values: cases
default: cases
data
\nobject
Data for detaching security findings from their case.
id
\nstring
Unique identifier of the detachment request.
relationships
\nobject
Relationships detaching security findings from their case.
findings [required]
\nobject
Security findings to detach from their case.
data
\n[object]
Array of security finding data objects.
id [required]
\nstring
Unique identifier of the security finding.
type [required]
\nenum
Security findings resource type. \nAllowed enum values: findings
default: findings
type [required]
\nenum
Cases resource type. \nAllowed enum values: cases
default: cases
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]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\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 12
\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 13
\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 14
\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 15
\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 16
\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 17
\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 18
\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 19
\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 20
\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
\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]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\nobject
Schema for an incident declared trigger.
incidentCreatedTrigger [required]
\nobject
Trigger a workflow when an incident is declared.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for an incident impact created trigger.
incidentImpactCreatedTrigger [required]
\nobject
Trigger a workflow when an impact is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an incident impact updated trigger.
incidentImpactUpdatedTrigger [required]
\nobject
Trigger a workflow when an impact is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for an incident postmortem updated trigger.
incidentPostmortemUpdatedTrigger [required]
\nobject
Trigger a workflow when a postmortem is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for an incident responder created trigger.
incidentResponderCreatedTrigger [required]
\nobject
Trigger a workflow when a responder is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for an incident declared or updated trigger.
incidentSavedTrigger [required]
\nobject
Trigger a workflow when an incident is declared or updated.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
serialExecution
\nobject
Whether to execute the workflow serially for an incident.
enabled [required]
\nboolean
Whether serial execution is enabled.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for an incident schedule trigger.
incidentScheduleTrigger [required]
\nobject
Trigger a workflow on a schedule for an incident.
incidentType
\nstring
The type of incident that triggers the workflow.
rrule [required]
\nstring
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\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
version
\nstring
Version of the incident manual trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\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 20
\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 21
\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 22
\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 23
\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 24
\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 25
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
reactionTriggers
\n[object]
Slack emoji reactions that trigger the workflow.
reactionEmoji [required]
\nstring
The Slack emoji reaction name.
teamId [required]
\nstring
The Slack workspace ID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 26
\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 27
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\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 12
\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 13
\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 14
\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 15
\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 16
\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 17
\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 18
\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 19
\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 20
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\nobject
Schema for an incident declared trigger.
incidentCreatedTrigger [required]
\nobject
Trigger a workflow when an incident is declared.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for an incident impact created trigger.
incidentImpactCreatedTrigger [required]
\nobject
Trigger a workflow when an impact is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an incident impact updated trigger.
incidentImpactUpdatedTrigger [required]
\nobject
Trigger a workflow when an impact is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for an incident postmortem updated trigger.
incidentPostmortemUpdatedTrigger [required]
\nobject
Trigger a workflow when a postmortem is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for an incident responder created trigger.
incidentResponderCreatedTrigger [required]
\nobject
Trigger a workflow when a responder is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for an incident declared or updated trigger.
incidentSavedTrigger [required]
\nobject
Trigger a workflow when an incident is declared or updated.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
serialExecution
\nobject
Whether to execute the workflow serially for an incident.
enabled [required]
\nboolean
Whether serial execution is enabled.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for an incident schedule trigger.
incidentScheduleTrigger [required]
\nobject
Trigger a workflow on a schedule for an incident.
incidentType
\nstring
The type of incident that triggers the workflow.
rrule [required]
\nstring
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\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
version
\nstring
Version of the incident manual trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\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 20
\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 21
\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 22
\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 23
\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 24
\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 25
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
reactionTriggers
\n[object]
Slack emoji reactions that trigger the workflow.
reactionEmoji [required]
\nstring
The Slack emoji reaction name.
teamId [required]
\nstring
The Slack workspace ID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 26
\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 27
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\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 12
\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 13
\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 14
\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 15
\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 16
\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 17
\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 18
\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 19
\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 20
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\nobject
Schema for an incident declared trigger.
incidentCreatedTrigger [required]
\nobject
Trigger a workflow when an incident is declared.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for an incident impact created trigger.
incidentImpactCreatedTrigger [required]
\nobject
Trigger a workflow when an impact is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an incident impact updated trigger.
incidentImpactUpdatedTrigger [required]
\nobject
Trigger a workflow when an impact is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for an incident postmortem updated trigger.
incidentPostmortemUpdatedTrigger [required]
\nobject
Trigger a workflow when a postmortem is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for an incident responder created trigger.
incidentResponderCreatedTrigger [required]
\nobject
Trigger a workflow when a responder is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for an incident declared or updated trigger.
incidentSavedTrigger [required]
\nobject
Trigger a workflow when an incident is declared or updated.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
serialExecution
\nobject
Whether to execute the workflow serially for an incident.
enabled [required]
\nboolean
Whether serial execution is enabled.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for an incident schedule trigger.
incidentScheduleTrigger [required]
\nobject
Trigger a workflow on a schedule for an incident.
incidentType
\nstring
The type of incident that triggers the workflow.
rrule [required]
\nstring
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\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
version
\nstring
Version of the incident manual trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\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 20
\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 21
\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 22
\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 23
\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 24
\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 25
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
reactionTriggers
\n[object]
Slack emoji reactions that trigger the workflow.
reactionEmoji [required]
\nstring
The Slack emoji reaction name.
teamId [required]
\nstring
The Slack workspace ID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 26
\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 27
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\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 12
\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 13
\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 14
\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 15
\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 16
\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 17
\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 18
\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 19
\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 20
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\nobject
Schema for an incident declared trigger.
incidentCreatedTrigger [required]
\nobject
Trigger a workflow when an incident is declared.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for an incident impact created trigger.
incidentImpactCreatedTrigger [required]
\nobject
Trigger a workflow when an impact is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an incident impact updated trigger.
incidentImpactUpdatedTrigger [required]
\nobject
Trigger a workflow when an impact is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for an incident postmortem updated trigger.
incidentPostmortemUpdatedTrigger [required]
\nobject
Trigger a workflow when a postmortem is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for an incident responder created trigger.
incidentResponderCreatedTrigger [required]
\nobject
Trigger a workflow when a responder is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for an incident declared or updated trigger.
incidentSavedTrigger [required]
\nobject
Trigger a workflow when an incident is declared or updated.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
serialExecution
\nobject
Whether to execute the workflow serially for an incident.
enabled [required]
\nboolean
Whether serial execution is enabled.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for an incident schedule trigger.
incidentScheduleTrigger [required]
\nobject
Trigger a workflow on a schedule for an incident.
incidentType
\nstring
The type of incident that triggers the workflow.
rrule [required]
\nstring
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\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
version
\nstring
Version of the incident manual trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\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 20
\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 21
\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 22
\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 23
\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 24
\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 25
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
reactionTriggers
\n[object]
Slack emoji reactions that trigger the workflow.
reactionEmoji [required]
\nstring
The Slack emoji reaction name.
teamId [required]
\nstring
The Slack workspace ID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 26
\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 27
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\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 12
\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 13
\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 14
\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 15
\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 16
\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 17
\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 18
\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 19
\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 20
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\nobject
Schema for an incident declared trigger.
incidentCreatedTrigger [required]
\nobject
Trigger a workflow when an incident is declared.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for an incident impact created trigger.
incidentImpactCreatedTrigger [required]
\nobject
Trigger a workflow when an impact is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an incident impact updated trigger.
incidentImpactUpdatedTrigger [required]
\nobject
Trigger a workflow when an impact is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for an incident postmortem updated trigger.
incidentPostmortemUpdatedTrigger [required]
\nobject
Trigger a workflow when a postmortem is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for an incident responder created trigger.
incidentResponderCreatedTrigger [required]
\nobject
Trigger a workflow when a responder is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for an incident declared or updated trigger.
incidentSavedTrigger [required]
\nobject
Trigger a workflow when an incident is declared or updated.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
serialExecution
\nobject
Whether to execute the workflow serially for an incident.
enabled [required]
\nboolean
Whether serial execution is enabled.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for an incident schedule trigger.
incidentScheduleTrigger [required]
\nobject
Trigger a workflow on a schedule for an incident.
incidentType
\nstring
The type of incident that triggers the workflow.
rrule [required]
\nstring
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\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
version
\nstring
Version of the incident manual trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\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 20
\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 21
\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 22
\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 23
\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 24
\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 25
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
reactionTriggers
\n[object]
Slack emoji reactions that trigger the workflow.
reactionEmoji [required]
\nstring
The Slack emoji reaction name.
teamId [required]
\nstring
The Slack workspace ID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 26
\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 27
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\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 12
\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 13
\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 14
\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 15
\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 16
\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 17
\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 18
\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 19
\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 20
\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
A complete Workflow Automation definition, including its triggers, steps, and connections.
annotations
\n[object]
Up to 100 text annotations displayed on the workflow canvas.
display [required]
\nobject
The annotation's position and size on the workflow canvas.
bounds
\nobject
Canvas coordinates and dimensions for an annotation on the workflow canvas.
height
\ndouble
The annotation's height on the canvas.
width
\ndouble
The annotation's width on the canvas.
x
\ndouble
The annotation's horizontal canvas coordinate.
y
\ndouble
The annotation's vertical canvas coordinate.
id [required]
\nstring
The unique identifier of this annotation within the workflow.
markdownTextAnnotation [required]
\nobject
Markdown content displayed in an annotation.
text
\nstring
The annotation's Markdown content.
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. Input parameters are available under the Trigger object and can be referenced in workflow steps using {{ Trigger.<parameter_name> }}.
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 agent-based trigger.
agentTrigger [required]
\nobject
Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP.
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 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 3
\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 4
\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 5
\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 6
\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 7
\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 8
\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 9
\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 10
\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 11
\nobject
Schema for an incident declared trigger.
incidentCreatedTrigger [required]
\nobject
Trigger a workflow when an incident is declared.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 12
\nobject
Schema for an incident impact created trigger.
incidentImpactCreatedTrigger [required]
\nobject
Trigger a workflow when an impact is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 13
\nobject
Schema for an incident impact updated trigger.
incidentImpactUpdatedTrigger [required]
\nobject
Trigger a workflow when an impact is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 14
\nobject
Schema for an incident postmortem updated trigger.
incidentPostmortemUpdatedTrigger [required]
\nobject
Trigger a workflow when a postmortem is updated for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 15
\nobject
Schema for an incident responder created trigger.
incidentResponderCreatedTrigger [required]
\nobject
Trigger a workflow when a responder is created for an incident.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 16
\nobject
Schema for an incident declared or updated trigger.
incidentSavedTrigger [required]
\nobject
Trigger a workflow when an incident is declared or updated.
executionLimit
\nobject
The maximum number of times to execute a workflow for an incident.
count [required]
\nint32
The maximum number of workflow executions.
incidentType
\nstring
The type of incident that triggers the workflow.
serialExecution
\nobject
Whether to execute the workflow serially for an incident.
enabled [required]
\nboolean
Whether serial execution is enabled.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 17
\nobject
Schema for an incident schedule trigger.
incidentScheduleTrigger [required]
\nobject
Trigger a workflow on a schedule for an incident.
incidentType
\nstring
The type of incident that triggers the workflow.
rrule [required]
\nstring
The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
tagCondition
\nobject
Conditions that determine which incidents trigger the workflow.
tagValues
\n[object]
Incident tags and values used to filter matching incidents.
tag [required]
\nstring
The incident tag to match.
values [required]
\n[string]
The accepted values for the incident tag.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 18
\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
version
\nstring
Version of the incident manual trigger.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 19
\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 20
\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 21
\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 22
\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 23
\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 24
\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 25
\nobject
Schema for a Slack-based trigger.
slackTrigger [required]
\nobject
Trigger a workflow from Slack. The workflow must be published.
reactionTriggers
\n[object]
Slack emoji reactions that trigger the workflow.
reactionEmoji [required]
\nstring
The Slack emoji reaction name.
teamId [required]
\nstring
The Slack workspace ID.
startStepNames
\n[string]
Names of existing workflow steps that run first after a trigger fires.
Object 26
\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 27
\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
\n[object]
Array of results matching the search query.
attributes [required]
\nobject
Object containing the information of a search result.
impacted_sessions
\nint64
Count of sessions impacted by the issue over the queried time window.
impacted_users
\nint64
Count of users impacted by the issue over the queried time window.
total_count
\nint64
Total count of errors that match the issue over the queried time window.
id [required]
\nstring
Search result identifier (matches the nested issue's identifier).
relationships
\nobject
Relationships between the search result and other resources.
issue
\nobject
Relationship between the search result and the corresponding issue.
data [required]
\nobject
The issue the search result corresponds to.
id [required]
\nstring
Issue identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: issue
type [required]
\nenum
Type of the object. \nAllowed enum values: error_tracking_search_result
included
\n[ <oneOf>]
Array of resources related to the search results.
<type=issue>
\nobject
The issue matching the request.
attributes [required]
\nobject
Object containing the information of an issue.
error_message
\nstring
Error message associated with the issue.
error_type
\nstring
Type of the error that matches the issue.
file_path
\nstring
Path of the file where the issue occurred.
first_seen
\nint64
Timestamp of the first seen error in milliseconds since the Unix epoch.
first_seen_version
\nstring
The application version (for example, git commit hash) where the issue was first observed.
function_name
\nstring
Name of the function where the issue occurred.
is_crash
\nboolean
Error is a crash.
languages
\n[string]
Array of programming languages associated with the issue.
last_seen
\nint64
Timestamp of the last seen error in milliseconds since the Unix epoch.
last_seen_version
\nstring
The application version (for example, git commit hash) where the issue was last observed.
platform
\nenum
Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN
regression
\nobject
Regression information for an issue that was previously resolved and then reopened.
regressed_at [required]
\ndate-time
Timestamp when the issue was reopened (regressed).
regressed_at_version
\nstring
Application version where the regression was observed.
resolved_at [required]
\ndate-time
Timestamp when the issue was resolved before the regression.
service
\nstring
Service name.
state
\nenum
State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED
id [required]
\nstring
Issue identifier.
relationships
\nobject
Relationship between the issue and an assignee, case and/or teams.
assignee
\nobject
Relationship between the issue and assignee.
data [required]
\nobject
The user the issue is assigned to.
id [required]
\nstring
User identifier.
type [required]
\nenum
Type of the object \nAllowed enum values: user
case
\nobject
Relationship between the issue and case.
data [required]
\nobject
The case the issue is attached to.
id [required]
\nstring
Case identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: case
team_owners
\nobject
Relationship between the issue and teams.
data [required]
\n[object]
Array of teams that are owners of the issue.
id [required]
\nstring
Team identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: team
type [required]
\nenum
Type of the object. \nAllowed enum values: issue
<type=case>
\nobject
A case
attributes [required]
\nobject
Case resource attributes
archived_at
\ndate-time
Timestamp of when the case was archived
attributes
\nobject
Key-value pairs of case attributes. Each key maps to an array of string values, used for flexible metadata such as labels or tags.
<any-key>
\n[string]
closed_at
\ndate-time
Timestamp of when the case was closed
created_at
\ndate-time
Timestamp of when the case was created
custom_attributes
\nobject
Case custom attributes
<any-key>
\nobject
A typed value for a custom attribute on a specific case.
is_multi [required]
\nboolean
If true, value must be an array
type [required]
\nenum
The data type of the custom attribute, which determines the allowed values and UI input control. \nAllowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
\n<oneOf>
The value of a custom attribute. The accepted format depends on the attribute's type and whether it accepts multiple values.
Object 1
\nstring
A string value for a TEXT, URL, or SELECT-type custom attribute.
Object 2
\n[string]
An array of string values for a multi-value TEXT, URL, or SELECT-type custom attribute.
Object 3
\ndouble
A numeric value for a NUMBER-type custom attribute.
Object 4
\n[number]
An array of numeric values for a multi-value NUMBER-type custom attribute.
description
\nstring
Description
jira_issue
\nobject
Jira issue attached to case
result
\nobject
Jira issue information
issue_id
\nstring
Jira issue ID
issue_key
\nstring
Jira issue key
issue_url
\nstring
Jira issue URL
project_key
\nstring
Jira project key
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
key
\nstring
Key
modified_at
\ndate-time
Timestamp of when the case was last modified
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
service_now_ticket
\nobject
ServiceNow ticket attached to case
result
\nobject
ServiceNow ticket information
sys_target_link
\nstring
Link to the Incident created on ServiceNow
status
\nenum
Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED
default: IN_PROGRESS
status
\nenum
DEPRECATED: Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use status_name instead. \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
status_group
\nenum
Status group of the case. \nAllowed enum values: SG_OPEN,SG_IN_PROGRESS,SG_CLOSED
status_name
\nstring
Status of the case. Must be one of the existing statuses for the case's type.
title
\nstring
Title
type
\nenum
DEPRECATED: Case type \nAllowed enum values: STANDARD
type_id
\nstring
Case type UUID
id [required]
\nstring
Case's identifier
relationships
\nobject
Resources related to a case
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project.
data [required]
\nobject
Relationship to project object.
id [required]
\nstring
A unique identifier that represents the project.
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
type [required]
\nenum
JSON:API resource type for cases. \nAllowed enum values: case
default: case
<type=user>
\nobject
The user to whom the issue is assigned.
attributes [required]
\nobject
Object containing the information of a user.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
id [required]
\nstring
User identifier.
type [required]
\nenum
Type of the object \nAllowed enum values: user
<type=team>
\nobject
A team that owns an issue.
attributes [required]
\nobject
Object containing the information of a team.
handle
\nstring
The team's identifier.
name
\nstring
The name of the team.
summary
\nstring
A brief summary of the team, derived from its description.
id [required]
\nstring
Team identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: team
data
\n[object]
Array of results matching the search query.
attributes [required]
\nobject
Object containing the information of a search result.
impacted_sessions
\nint64
Count of sessions impacted by the issue over the queried time window.
impacted_users
\nint64
Count of users impacted by the issue over the queried time window.
total_count
\nint64
Total count of errors that match the issue over the queried time window.
id [required]
\nstring
Search result identifier (matches the nested issue's identifier).
relationships
\nobject
Relationships between the search result and other resources.
issue
\nobject
Relationship between the search result and the corresponding issue.
data [required]
\nobject
The issue the search result corresponds to.
id [required]
\nstring
Issue identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: issue
type [required]
\nenum
Type of the object. \nAllowed enum values: error_tracking_search_result
included
\n[ <oneOf>]
Array of resources related to the search results.
<type=issue>
\nobject
The issue matching the request.
attributes [required]
\nobject
Object containing the information of an issue.
error_message
\nstring
Error message associated with the issue.
error_type
\nstring
Type of the error that matches the issue.
file_path
\nstring
Path of the file where the issue occurred.
first_seen
\nint64
Timestamp of the first seen error in milliseconds since the Unix epoch.
first_seen_version
\nstring
The application version (for example, git commit hash) where the issue was first observed.
function_name
\nstring
Name of the function where the issue occurred.
is_crash
\nboolean
Error is a crash.
languages
\n[string]
Array of programming languages associated with the issue.
last_seen
\nint64
Timestamp of the last seen error in milliseconds since the Unix epoch.
last_seen_version
\nstring
The application version (for example, git commit hash) where the issue was last observed.
platform
\nenum
Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN
regression
\nobject
Regression information for an issue that was previously resolved and then reopened.
regressed_at [required]
\ndate-time
Timestamp when the issue was reopened (regressed).
regressed_at_version
\nstring
Application version where the regression was observed.
resolved_at [required]
\ndate-time
Timestamp when the issue was resolved before the regression.
service
\nstring
Service name.
state
\nenum
State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED
id [required]
\nstring
Issue identifier.
relationships
\nobject
Relationship between the issue and an assignee, case and/or teams.
assignee
\nobject
Relationship between the issue and assignee.
data [required]
\nobject
The user the issue is assigned to.
id [required]
\nstring
User identifier.
type [required]
\nenum
Type of the object \nAllowed enum values: user
case
\nobject
Relationship between the issue and case.
data [required]
\nobject
The case the issue is attached to.
id [required]
\nstring
Case identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: case
team_owners
\nobject
Relationship between the issue and teams.
data [required]
\n[object]
Array of teams that are owners of the issue.
id [required]
\nstring
Team identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: team
type [required]
\nenum
Type of the object. \nAllowed enum values: issue
<type=case>
\nobject
The case attached to the issue.
attributes [required]
\nobject
Object containing the information of a case.
archived_at
\ndate-time
Timestamp of when the case was archived.
closed_at
\ndate-time
Timestamp of when the case was closed.
created_at
\ndate-time
Timestamp of when the case was created.
creation_source
\nstring
Source of the case creation.
description
\nstring
Description of the case.
due_date
\nstring
Due date of the case.
insights
\n[object]
Insights of the case.
ref
\nstring
Reference of the insight.
resource_id
\nstring
Insight identifier.
type
\nstring
Type of the insight.
jira_issue
\nobject
Jira issue of the case.
error_message
\nstring
Error message set when the Jira issue creation fails.
result
\nobject
Contains the identifiers and URL for a successfully created Jira issue.
account_id
\nstring
Jira account identifier.
issue_id
\nstring
Jira issue identifier.
issue_key
\nstring
Jira issue key.
issue_url
\nstring
Jira issue URL.
project_id
\nstring
Jira project identifier.
project_key
\nstring
Jira project key.
status
\nstring
Creation status of the Jira issue.
key
\nstring
Key of the case.
linear_issue
\nobject
Linear issue of the case.
error_message
\nstring
Error message set when the Linear issue creation fails.
result
\nobject
Contains the identifiers and URL for a successfully created Linear issue.
account_id
\nstring
Linear account identifier.
issue_id
\nstring
Linear issue identifier.
issue_key
\nstring
Linear issue key.
issue_url
\nstring
Linear issue URL.
team_id
\nstring
Linear team identifier.
status
\nstring
Creation status of the Linear issue.
modified_at
\ndate-time
Timestamp of when the case was last modified.
priority
\nenum
Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5
default: NOT_DEFINED
status
\nenum
DEPRECATED: Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use status_name instead. \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED
title
\nstring
Title of the case.
type
\nstring
Type of the case.
id [required]
\nstring
Case identifier.
relationships
\nobject
Resources related to a case.
assignee
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
project
\nobject
Relationship to project.
data [required]
\nobject
Relationship to project object.
id [required]
\nstring
A unique identifier that represents the project.
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
type [required]
\nenum
Type of the object. \nAllowed enum values: case
<type=user>
\nobject
The user to whom the issue is assigned.
attributes [required]
\nobject
Object containing the information of a user.
string
Email of the user.
handle
\nstring
Handle of the user.
name
\nstring
Name of the user.
id [required]
\nstring
User identifier.
type [required]
\nenum
Type of the object \nAllowed enum values: user
<type=team>
\nobject
A team that owns an issue.
attributes [required]
\nobject
Object containing the information of a team.
handle
\nstring
The team's identifier.
name
\nstring
The name of the team.
summary
\nstring
A brief summary of the team, derived from its description.
id [required]
\nstring
Team identifier.
type [required]
\nenum
Type of the object. \nAllowed enum values: team