From f3a40cb444865322f7c300acef9091ac64d03ca2 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 21 Aug 2026 19:28:46 +0000 Subject: [PATCH] Regenerate client from commit 48d645b of spec repo --- .../api/v2/workflow-automation/examples.json | 12 ++++----- hugo/data/api/v2/full_spec.yaml | 25 +++++++++++-------- 2 files changed, 20 insertions(+), 17 deletions(-) diff --git a/hugo/content/en/api/v2/workflow-automation/examples.json b/hugo/content/en/api/v2/workflow-automation/examples.json index 638a6869fd7..67bd309f2ce 100644 --- a/hugo/content/en/api/v2/workflow-automation/examples.json +++ b/hugo/content/en/api/v2/workflow-automation/examples.json @@ -169,7 +169,7 @@ } } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of workflows.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a workflow returned in a list response.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

A list of annotations used in the workflow. These are like sticky notes for your workflow!

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The definition of AnnotationDisplay object.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of AnnotationDisplayBounds object.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The bounds height.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The bounds width.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Annotation id.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

The definition of AnnotationMarkdownTextAnnotation object.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The markdownTextAnnotation text.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Metadata for a List Workflows response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination metadata for a List Workflows response.

\n
\n
\n
\n
\n
\n

totalCount

\n
\n

int64

\n

The total number of workflows in the organization.

\n
\n \n
\n
\n
\n
\n
\n

totalFilteredCount

\n
\n

int64

\n

The total number of workflows matching the applied filters.

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of workflows.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a workflow returned in a list response.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Metadata for a List Workflows response.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Pagination metadata for a List Workflows response.

\n
\n
\n
\n
\n
\n

totalCount

\n
\n

int64

\n

The total number of workflows in the organization.

\n
\n \n
\n
\n
\n
\n
\n

totalFilteredCount

\n
\n

int64

\n

The total number of workflows matching the applied filters.

\n
\n \n
\n
\n
\n
\n
\n
" }, "400": { "json": { @@ -365,7 +365,7 @@ "type": "workflows" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

A list of annotations used in the workflow. These are like sticky notes for your workflow!

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The definition of AnnotationDisplay object.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of AnnotationDisplayBounds object.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The bounds height.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The bounds width.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Annotation id.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

The definition of AnnotationMarkdownTextAnnotation object.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The markdownTextAnnotation text.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -665,7 +665,7 @@ "type": "workflows" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

A list of annotations used in the workflow. These are like sticky notes for your workflow!

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The definition of AnnotationDisplay object.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of AnnotationDisplayBounds object.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The bounds height.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The bounds width.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Annotation id.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

The definition of AnnotationMarkdownTextAnnotation object.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The markdownTextAnnotation text.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" } }, "DeleteWorkflow": { @@ -894,7 +894,7 @@ "type": "workflows" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

A list of annotations used in the workflow. These are like sticky notes for your workflow!

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The definition of AnnotationDisplay object.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of AnnotationDisplayBounds object.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The bounds height.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The bounds width.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Annotation id.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

The definition of AnnotationMarkdownTextAnnotation object.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The markdownTextAnnotation text.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1138,7 +1138,7 @@ "type": "workflows" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the workflow being updated.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataUpdateAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

A list of annotations used in the workflow. These are like sticky notes for your workflow!

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The definition of AnnotationDisplay object.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of AnnotationDisplayBounds object.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The bounds height.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The bounds width.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Annotation id.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

The definition of AnnotationMarkdownTextAnnotation object.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The markdownTextAnnotation text.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the workflow being updated.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataUpdateAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1456,7 +1456,7 @@ "type": "workflows" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the workflow being updated.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataUpdateAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

A list of annotations used in the workflow. These are like sticky notes for your workflow!

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The definition of AnnotationDisplay object.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of AnnotationDisplayBounds object.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The bounds height.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The bounds width.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Annotation id.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

The definition of AnnotationMarkdownTextAnnotation object.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The markdownTextAnnotation text.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the workflow being updated.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataUpdateAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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> }}.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

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_NULL

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an Incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" } }, "ListWorkflowInstances": { diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 2b6dc020f3a..afdd06d99eb 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -7185,13 +7185,14 @@ components: - fixes type: object Annotation: - description: "A list of annotations used in the workflow. These are like sticky notes for your workflow!" + description: A text annotation displayed on the workflow canvas. properties: display: $ref: "#/components/schemas/AnnotationDisplay" id: - description: The `Annotation` `id`. + description: The unique identifier of this annotation within the workflow. example: "" + minLength: 1 type: string markdownTextAnnotation: $ref: "#/components/schemas/AnnotationMarkdownTextAnnotation" @@ -7348,28 +7349,28 @@ components: - attributes type: object AnnotationDisplay: - description: The definition of `AnnotationDisplay` object. + description: The annotation's position and size on the workflow canvas. properties: bounds: $ref: "#/components/schemas/AnnotationDisplayBounds" type: object AnnotationDisplayBounds: - description: The definition of `AnnotationDisplayBounds` object. + description: Canvas coordinates and dimensions for an annotation on the workflow canvas. properties: height: - description: The `bounds` `height`. + description: The annotation's height on the canvas. format: double type: number width: - description: The `bounds` `width`. + description: The annotation's width on the canvas. format: double type: number x: - description: The `bounds` `x`. + description: The annotation's horizontal canvas coordinate. format: double type: number y: - description: The `bounds` `y`. + description: The annotation's vertical canvas coordinate. format: double type: number type: object @@ -7453,10 +7454,11 @@ components: - POINT_IN_TIME - TIME_REGION AnnotationMarkdownTextAnnotation: - description: The definition of `AnnotationMarkdownTextAnnotation` object. + description: Markdown content displayed in an annotation. properties: text: - description: The `markdownTextAnnotation` `text`. + description: The annotation's Markdown content. + maxLength: 3000 type: string type: object AnnotationRequestData: @@ -108548,9 +108550,10 @@ components: description: A complete Workflow Automation definition, including its triggers, steps, and connections. properties: annotations: - description: "A list of annotations used in the workflow. These are like sticky notes for your workflow!" + description: Up to 100 text annotations displayed on the workflow canvas. items: $ref: "#/components/schemas/Annotation" + maxItems: 100 type: array connectionEnvs: description: A list of connections or connection groups used in the workflow.