Datadog Workflow Automation allows you to automate your end-to-end processes by connecting Datadog with the rest of your tech stack. Build workflows to auto-remediate your alerts, streamline your incident and security processes, and reduce manual toil. Workflow Automation supports over 1,000+ OOTB actions, including AWS, JIRA, ServiceNow, GitHub, and OpenAI. Learn more in our Workflow Automation docs here.
Get a workflow by ID. This API requires an application key scoped with the workflows_read permission.
This endpoint requires the workflows_read permission.
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
object
The spec defines what the workflow does.
annotations
[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
object
The definition of AnnotationDisplay object.
bounds
object
The definition of AnnotationDisplayBounds object.
height
double
The boundsheight.
width
double
The boundswidth.
x
double
The boundsx.
y
double
The boundsy.
id [required]
string
The Annotationid.
markdownTextAnnotation [required]
object
The definition of AnnotationMarkdownTextAnnotation object.
text
string
The markdownTextAnnotationtext.
connectionEnvs
[object]
A list of connections or connection groups used in the workflow.
connectionGroups
[object]
The ConnectionEnvconnectionGroups.
connectionGroupId [required]
string
The ConnectionGroupconnectionGroupId.
label [required]
string
The ConnectionGrouplabel.
tags [required]
[string]
The ConnectionGrouptags.
connections
[object]
The ConnectionEnvconnections.
connectionId [required]
string
The ConnectionconnectionId.
label [required]
string
The Connectionlabel.
env [required]
enum
The definition of ConnectionEnvEnv object.
Allowed enum values: default
handle
string
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
object
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
[object]
The InputSchemaparameters.
defaultValue
The InputSchemaParametersdefaultValue.
description
string
The InputSchemaParametersdescription.
label
string
The InputSchemaParameterslabel.
name [required]
string
The InputSchemaParametersname.
type [required]
enum
The definition of InputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
object
A list of output parameters for the workflow.
parameters
[object]
The OutputSchemaparameters.
defaultValue
The OutputSchemaParametersdefaultValue.
description
string
The OutputSchemaParametersdescription.
label
string
The OutputSchemaParameterslabel.
name [required]
string
The OutputSchemaParametersname.
type [required]
enum
The definition of OutputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
The OutputSchemaParametersvalue.
steps
[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
string
The unique identifier of an action.
completionGate
object
Used to create conditions before running subsequent actions.
completionCondition [required]
object
The definition of CompletionCondition object.
operand1 [required]
The CompletionConditionoperand1.
operand2
The CompletionConditionoperand2.
operator [required]
enum
The definition of CompletionConditionOperator object.
Allowed 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,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
connectionLabel
string
The unique identifier of a connection defined in the spec.
display
object
The definition of StepDisplay object.
bounds
object
The definition of StepDisplayBounds object.
x
double
The boundsx.
y
double
The boundsy.
errorHandlers
[object]
The SteperrorHandlers.
fallbackStepName [required]
string
The ErrorHandlerfallbackStepName.
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
name [required]
string
Name of the step.
outboundEdges
[object]
A list of subsequent actions to run.
branchName [required]
string
The OutboundEdgebranchName.
nextStepName [required]
string
The OutboundEdgenextStepName.
parameters
[object]
A list of inputs for an action.
name [required]
string
The Parametername.
value [required]
The Parametervalue.
readinessGate
object
Used to merge multiple branches into a single branch.
thresholdType [required]
enum
The definition of ReadinessGateThresholdType object.
Allowed enum values: ANY,ALL
triggers
[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Option 1
object
Schema for an API-based trigger.
apiTrigger [required]
object
Trigger a workflow VIA an API. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 2
object
Schema for an App-based trigger.
appTrigger [required]
object
Trigger a workflow VIA an App.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 3
object
Schema for a Case-based trigger.
caseTrigger [required]
object
Trigger a workflow VIA a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 4
object
Schema for a Change Event-based trigger.
changeEventTrigger [required]
object
Trigger a workflow VIA a Change Event.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 5
object
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
object
Trigger a workflow VIA a Dashboard.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 6
object
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
object
Trigger a workflow VIA GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 7
object
Schema for an Incident-based trigger.
incidentTrigger [required]
object
Trigger a workflow VIA an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 8
object
Schema for a Monitor-based trigger.
monitorTrigger [required]
object
Trigger a workflow VIA a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 9
object
Schema for a Schedule-based trigger.
scheduleTrigger [required]
object
Trigger a workflow VIA a Schedule. The workflow must be published.
rruleExpression [required]
string
Recurrence rule expression for scheduling.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 10
object
Schema for a Security-based trigger.
securityTrigger [required]
object
Trigger a workflow VIA a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 11
object
Schema for a Slack-based trigger.
slackTrigger [required]
object
Trigger a workflow VIA Slack. The workflow must be published.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 12
object
Schema for a Workflow-based trigger.
startStepNames
[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
object
Trigger a workflow VIA the Datadog UI. Only required if no other trigger exists.
tags
[string]
Tags of the workflow.
updatedAt
date-time
When the workflow was last updated.
webhookSecret
string
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
string
The workflow identifier
relationships
object
The definition of WorkflowDataRelationships object.
creator
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
owner
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
type [required]
enum
The definition of WorkflowDataType object.
Allowed enum values: workflows
Create a new workflow, returning the workflow ID. This API requires an application key scoped with the workflows_write permission.
This endpoint requires the workflows_write permission.
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
object
The spec defines what the workflow does.
annotations
[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
object
The definition of AnnotationDisplay object.
bounds
object
The definition of AnnotationDisplayBounds object.
height
double
The boundsheight.
width
double
The boundswidth.
x
double
The boundsx.
y
double
The boundsy.
id [required]
string
The Annotationid.
markdownTextAnnotation [required]
object
The definition of AnnotationMarkdownTextAnnotation object.
text
string
The markdownTextAnnotationtext.
connectionEnvs
[object]
A list of connections or connection groups used in the workflow.
connectionGroups
[object]
The ConnectionEnvconnectionGroups.
connectionGroupId [required]
string
The ConnectionGroupconnectionGroupId.
label [required]
string
The ConnectionGrouplabel.
tags [required]
[string]
The ConnectionGrouptags.
connections
[object]
The ConnectionEnvconnections.
connectionId [required]
string
The ConnectionconnectionId.
label [required]
string
The Connectionlabel.
env [required]
enum
The definition of ConnectionEnvEnv object.
Allowed enum values: default
handle
string
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
object
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
[object]
The InputSchemaparameters.
defaultValue
The InputSchemaParametersdefaultValue.
description
string
The InputSchemaParametersdescription.
label
string
The InputSchemaParameterslabel.
name [required]
string
The InputSchemaParametersname.
type [required]
enum
The definition of InputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
object
A list of output parameters for the workflow.
parameters
[object]
The OutputSchemaparameters.
defaultValue
The OutputSchemaParametersdefaultValue.
description
string
The OutputSchemaParametersdescription.
label
string
The OutputSchemaParameterslabel.
name [required]
string
The OutputSchemaParametersname.
type [required]
enum
The definition of OutputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
The OutputSchemaParametersvalue.
steps
[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
string
The unique identifier of an action.
completionGate
object
Used to create conditions before running subsequent actions.
completionCondition [required]
object
The definition of CompletionCondition object.
operand1 [required]
The CompletionConditionoperand1.
operand2
The CompletionConditionoperand2.
operator [required]
enum
The definition of CompletionConditionOperator object.
Allowed 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,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
connectionLabel
string
The unique identifier of a connection defined in the spec.
display
object
The definition of StepDisplay object.
bounds
object
The definition of StepDisplayBounds object.
x
double
The boundsx.
y
double
The boundsy.
errorHandlers
[object]
The SteperrorHandlers.
fallbackStepName [required]
string
The ErrorHandlerfallbackStepName.
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
name [required]
string
Name of the step.
outboundEdges
[object]
A list of subsequent actions to run.
branchName [required]
string
The OutboundEdgebranchName.
nextStepName [required]
string
The OutboundEdgenextStepName.
parameters
[object]
A list of inputs for an action.
name [required]
string
The Parametername.
value [required]
The Parametervalue.
readinessGate
object
Used to merge multiple branches into a single branch.
thresholdType [required]
enum
The definition of ReadinessGateThresholdType object.
Allowed enum values: ANY,ALL
triggers
[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Option 1
object
Schema for an API-based trigger.
apiTrigger [required]
object
Trigger a workflow VIA an API. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 2
object
Schema for an App-based trigger.
appTrigger [required]
object
Trigger a workflow VIA an App.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 3
object
Schema for a Case-based trigger.
caseTrigger [required]
object
Trigger a workflow VIA a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 4
object
Schema for a Change Event-based trigger.
changeEventTrigger [required]
object
Trigger a workflow VIA a Change Event.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 5
object
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
object
Trigger a workflow VIA a Dashboard.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 6
object
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
object
Trigger a workflow VIA GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 7
object
Schema for an Incident-based trigger.
incidentTrigger [required]
object
Trigger a workflow VIA an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 8
object
Schema for a Monitor-based trigger.
monitorTrigger [required]
object
Trigger a workflow VIA a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 9
object
Schema for a Schedule-based trigger.
scheduleTrigger [required]
object
Trigger a workflow VIA a Schedule. The workflow must be published.
rruleExpression [required]
string
Recurrence rule expression for scheduling.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 10
object
Schema for a Security-based trigger.
securityTrigger [required]
object
Trigger a workflow VIA a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 11
object
Schema for a Slack-based trigger.
slackTrigger [required]
object
Trigger a workflow VIA Slack. The workflow must be published.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 12
object
Schema for a Workflow-based trigger.
startStepNames
[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
object
Trigger a workflow VIA the Datadog UI. Only required if no other trigger exists.
tags
[string]
Tags of the workflow.
updatedAt
date-time
When the workflow was last updated.
webhookSecret
string
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
string
The workflow identifier
relationships
object
The definition of WorkflowDataRelationships object.
creator
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
owner
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
type [required]
enum
The definition of WorkflowDataType object.
Allowed enum values: workflows
The response object after creating a new workflow.
Expand All
フィールド
種類
説明
data [required]
object
Data related to the workflow.
attributes [required]
object
The definition of WorkflowDataAttributes object.
createdAt
date-time
When the workflow was created.
description
string
Description of the workflow.
name [required]
string
Name of the workflow.
published
boolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec [required]
object
The spec defines what the workflow does.
annotations
[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
object
The definition of AnnotationDisplay object.
bounds
object
The definition of AnnotationDisplayBounds object.
height
double
The boundsheight.
width
double
The boundswidth.
x
double
The boundsx.
y
double
The boundsy.
id [required]
string
The Annotationid.
markdownTextAnnotation [required]
object
The definition of AnnotationMarkdownTextAnnotation object.
text
string
The markdownTextAnnotationtext.
connectionEnvs
[object]
A list of connections or connection groups used in the workflow.
connectionGroups
[object]
The ConnectionEnvconnectionGroups.
connectionGroupId [required]
string
The ConnectionGroupconnectionGroupId.
label [required]
string
The ConnectionGrouplabel.
tags [required]
[string]
The ConnectionGrouptags.
connections
[object]
The ConnectionEnvconnections.
connectionId [required]
string
The ConnectionconnectionId.
label [required]
string
The Connectionlabel.
env [required]
enum
The definition of ConnectionEnvEnv object.
Allowed enum values: default
handle
string
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
object
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
[object]
The InputSchemaparameters.
defaultValue
The InputSchemaParametersdefaultValue.
description
string
The InputSchemaParametersdescription.
label
string
The InputSchemaParameterslabel.
name [required]
string
The InputSchemaParametersname.
type [required]
enum
The definition of InputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
object
A list of output parameters for the workflow.
parameters
[object]
The OutputSchemaparameters.
defaultValue
The OutputSchemaParametersdefaultValue.
description
string
The OutputSchemaParametersdescription.
label
string
The OutputSchemaParameterslabel.
name [required]
string
The OutputSchemaParametersname.
type [required]
enum
The definition of OutputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
The OutputSchemaParametersvalue.
steps
[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
string
The unique identifier of an action.
completionGate
object
Used to create conditions before running subsequent actions.
completionCondition [required]
object
The definition of CompletionCondition object.
operand1 [required]
The CompletionConditionoperand1.
operand2
The CompletionConditionoperand2.
operator [required]
enum
The definition of CompletionConditionOperator object.
Allowed 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,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
connectionLabel
string
The unique identifier of a connection defined in the spec.
display
object
The definition of StepDisplay object.
bounds
object
The definition of StepDisplayBounds object.
x
double
The boundsx.
y
double
The boundsy.
errorHandlers
[object]
The SteperrorHandlers.
fallbackStepName [required]
string
The ErrorHandlerfallbackStepName.
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
name [required]
string
Name of the step.
outboundEdges
[object]
A list of subsequent actions to run.
branchName [required]
string
The OutboundEdgebranchName.
nextStepName [required]
string
The OutboundEdgenextStepName.
parameters
[object]
A list of inputs for an action.
name [required]
string
The Parametername.
value [required]
The Parametervalue.
readinessGate
object
Used to merge multiple branches into a single branch.
thresholdType [required]
enum
The definition of ReadinessGateThresholdType object.
Allowed enum values: ANY,ALL
triggers
[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Option 1
object
Schema for an API-based trigger.
apiTrigger [required]
object
Trigger a workflow VIA an API. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 2
object
Schema for an App-based trigger.
appTrigger [required]
object
Trigger a workflow VIA an App.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 3
object
Schema for a Case-based trigger.
caseTrigger [required]
object
Trigger a workflow VIA a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 4
object
Schema for a Change Event-based trigger.
changeEventTrigger [required]
object
Trigger a workflow VIA a Change Event.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 5
object
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
object
Trigger a workflow VIA a Dashboard.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 6
object
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
object
Trigger a workflow VIA GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 7
object
Schema for an Incident-based trigger.
incidentTrigger [required]
object
Trigger a workflow VIA an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 8
object
Schema for a Monitor-based trigger.
monitorTrigger [required]
object
Trigger a workflow VIA a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 9
object
Schema for a Schedule-based trigger.
scheduleTrigger [required]
object
Trigger a workflow VIA a Schedule. The workflow must be published.
rruleExpression [required]
string
Recurrence rule expression for scheduling.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 10
object
Schema for a Security-based trigger.
securityTrigger [required]
object
Trigger a workflow VIA a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 11
object
Schema for a Slack-based trigger.
slackTrigger [required]
object
Trigger a workflow VIA Slack. The workflow must be published.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 12
object
Schema for a Workflow-based trigger.
startStepNames
[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
object
Trigger a workflow VIA the Datadog UI. Only required if no other trigger exists.
tags
[string]
Tags of the workflow.
updatedAt
date-time
When the workflow was last updated.
webhookSecret
string
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
string
The workflow identifier
relationships
object
The definition of WorkflowDataRelationships object.
creator
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
owner
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
type [required]
enum
The definition of WorkflowDataType object.
Allowed enum values: workflows
Update a workflow by ID. This API requires an application key scoped with the workflows_write permission.
This endpoint requires the workflows_write permission.
The definition of WorkflowDataUpdateAttributes object.
createdAt
date-time
When the workflow was created.
description
string
Description of the workflow.
name
string
Name of the workflow.
published
boolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec
object
The spec defines what the workflow does.
annotations
[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
object
The definition of AnnotationDisplay object.
bounds
object
The definition of AnnotationDisplayBounds object.
height
double
The boundsheight.
width
double
The boundswidth.
x
double
The boundsx.
y
double
The boundsy.
id [required]
string
The Annotationid.
markdownTextAnnotation [required]
object
The definition of AnnotationMarkdownTextAnnotation object.
text
string
The markdownTextAnnotationtext.
connectionEnvs
[object]
A list of connections or connection groups used in the workflow.
connectionGroups
[object]
The ConnectionEnvconnectionGroups.
connectionGroupId [required]
string
The ConnectionGroupconnectionGroupId.
label [required]
string
The ConnectionGrouplabel.
tags [required]
[string]
The ConnectionGrouptags.
connections
[object]
The ConnectionEnvconnections.
connectionId [required]
string
The ConnectionconnectionId.
label [required]
string
The Connectionlabel.
env [required]
enum
The definition of ConnectionEnvEnv object.
Allowed enum values: default
handle
string
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
object
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
[object]
The InputSchemaparameters.
defaultValue
The InputSchemaParametersdefaultValue.
description
string
The InputSchemaParametersdescription.
label
string
The InputSchemaParameterslabel.
name [required]
string
The InputSchemaParametersname.
type [required]
enum
The definition of InputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
object
A list of output parameters for the workflow.
parameters
[object]
The OutputSchemaparameters.
defaultValue
The OutputSchemaParametersdefaultValue.
description
string
The OutputSchemaParametersdescription.
label
string
The OutputSchemaParameterslabel.
name [required]
string
The OutputSchemaParametersname.
type [required]
enum
The definition of OutputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
The OutputSchemaParametersvalue.
steps
[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
string
The unique identifier of an action.
completionGate
object
Used to create conditions before running subsequent actions.
completionCondition [required]
object
The definition of CompletionCondition object.
operand1 [required]
The CompletionConditionoperand1.
operand2
The CompletionConditionoperand2.
operator [required]
enum
The definition of CompletionConditionOperator object.
Allowed 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,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
connectionLabel
string
The unique identifier of a connection defined in the spec.
display
object
The definition of StepDisplay object.
bounds
object
The definition of StepDisplayBounds object.
x
double
The boundsx.
y
double
The boundsy.
errorHandlers
[object]
The SteperrorHandlers.
fallbackStepName [required]
string
The ErrorHandlerfallbackStepName.
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
name [required]
string
Name of the step.
outboundEdges
[object]
A list of subsequent actions to run.
branchName [required]
string
The OutboundEdgebranchName.
nextStepName [required]
string
The OutboundEdgenextStepName.
parameters
[object]
A list of inputs for an action.
name [required]
string
The Parametername.
value [required]
The Parametervalue.
readinessGate
object
Used to merge multiple branches into a single branch.
thresholdType [required]
enum
The definition of ReadinessGateThresholdType object.
Allowed enum values: ANY,ALL
triggers
[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Option 1
object
Schema for an API-based trigger.
apiTrigger [required]
object
Trigger a workflow VIA an API. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 2
object
Schema for an App-based trigger.
appTrigger [required]
object
Trigger a workflow VIA an App.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 3
object
Schema for a Case-based trigger.
caseTrigger [required]
object
Trigger a workflow VIA a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 4
object
Schema for a Change Event-based trigger.
changeEventTrigger [required]
object
Trigger a workflow VIA a Change Event.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 5
object
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
object
Trigger a workflow VIA a Dashboard.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 6
object
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
object
Trigger a workflow VIA GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 7
object
Schema for an Incident-based trigger.
incidentTrigger [required]
object
Trigger a workflow VIA an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 8
object
Schema for a Monitor-based trigger.
monitorTrigger [required]
object
Trigger a workflow VIA a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 9
object
Schema for a Schedule-based trigger.
scheduleTrigger [required]
object
Trigger a workflow VIA a Schedule. The workflow must be published.
rruleExpression [required]
string
Recurrence rule expression for scheduling.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 10
object
Schema for a Security-based trigger.
securityTrigger [required]
object
Trigger a workflow VIA a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 11
object
Schema for a Slack-based trigger.
slackTrigger [required]
object
Trigger a workflow VIA Slack. The workflow must be published.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 12
object
Schema for a Workflow-based trigger.
startStepNames
[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
object
Trigger a workflow VIA the Datadog UI. Only required if no other trigger exists.
tags
[string]
Tags of the workflow.
updatedAt
date-time
When the workflow was last updated.
webhookSecret
string
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
string
The workflow identifier
relationships
object
The definition of WorkflowDataRelationships object.
creator
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
owner
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
type [required]
enum
The definition of WorkflowDataType object.
Allowed enum values: workflows
The definition of WorkflowDataUpdateAttributes object.
createdAt
date-time
When the workflow was created.
description
string
Description of the workflow.
name
string
Name of the workflow.
published
boolean
Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec
object
The spec defines what the workflow does.
annotations
[object]
A list of annotations used in the workflow. These are like sticky notes for your workflow!
display [required]
object
The definition of AnnotationDisplay object.
bounds
object
The definition of AnnotationDisplayBounds object.
height
double
The boundsheight.
width
double
The boundswidth.
x
double
The boundsx.
y
double
The boundsy.
id [required]
string
The Annotationid.
markdownTextAnnotation [required]
object
The definition of AnnotationMarkdownTextAnnotation object.
text
string
The markdownTextAnnotationtext.
connectionEnvs
[object]
A list of connections or connection groups used in the workflow.
connectionGroups
[object]
The ConnectionEnvconnectionGroups.
connectionGroupId [required]
string
The ConnectionGroupconnectionGroupId.
label [required]
string
The ConnectionGrouplabel.
tags [required]
[string]
The ConnectionGrouptags.
connections
[object]
The ConnectionEnvconnections.
connectionId [required]
string
The ConnectionconnectionId.
label [required]
string
The Connectionlabel.
env [required]
enum
The definition of ConnectionEnvEnv object.
Allowed enum values: default
handle
string
Unique identifier used to trigger workflows automatically in Datadog.
inputSchema
object
A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
parameters
[object]
The InputSchemaparameters.
defaultValue
The InputSchemaParametersdefaultValue.
description
string
The InputSchemaParametersdescription.
label
string
The InputSchemaParameterslabel.
name [required]
string
The InputSchemaParametersname.
type [required]
enum
The definition of InputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
outputSchema
object
A list of output parameters for the workflow.
parameters
[object]
The OutputSchemaparameters.
defaultValue
The OutputSchemaParametersdefaultValue.
description
string
The OutputSchemaParametersdescription.
label
string
The OutputSchemaParameterslabel.
name [required]
string
The OutputSchemaParametersname.
type [required]
enum
The definition of OutputSchemaParametersType object.
Allowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT
value
The OutputSchemaParametersvalue.
steps
[object]
A Step is a sub-component of a workflow. Each Step performs an action.
actionId [required]
string
The unique identifier of an action.
completionGate
object
Used to create conditions before running subsequent actions.
completionCondition [required]
object
The definition of CompletionCondition object.
operand1 [required]
The CompletionConditionoperand1.
operand2
The CompletionConditionoperand2.
operator [required]
enum
The definition of CompletionConditionOperator object.
Allowed 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,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
connectionLabel
string
The unique identifier of a connection defined in the spec.
display
object
The definition of StepDisplay object.
bounds
object
The definition of StepDisplayBounds object.
x
double
The boundsx.
y
double
The boundsy.
errorHandlers
[object]
The SteperrorHandlers.
fallbackStepName [required]
string
The ErrorHandlerfallbackStepName.
retryStrategy [required]
object
The definition of RetryStrategy object.
kind [required]
enum
The definition of RetryStrategyKind object.
Allowed enum values: RETRY_STRATEGY_LINEAR
linear
object
The definition of RetryStrategyLinear object.
interval [required]
string
The RetryStrategyLinearinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
maxRetries [required]
double
The RetryStrategyLinearmaxRetries.
name [required]
string
Name of the step.
outboundEdges
[object]
A list of subsequent actions to run.
branchName [required]
string
The OutboundEdgebranchName.
nextStepName [required]
string
The OutboundEdgenextStepName.
parameters
[object]
A list of inputs for an action.
name [required]
string
The Parametername.
value [required]
The Parametervalue.
readinessGate
object
Used to merge multiple branches into a single branch.
thresholdType [required]
enum
The definition of ReadinessGateThresholdType object.
Allowed enum values: ANY,ALL
triggers
[ <oneOf>]
The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
Option 1
object
Schema for an API-based trigger.
apiTrigger [required]
object
Trigger a workflow VIA an API. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 2
object
Schema for an App-based trigger.
appTrigger [required]
object
Trigger a workflow VIA an App.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 3
object
Schema for a Case-based trigger.
caseTrigger [required]
object
Trigger a workflow VIA a Case. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 4
object
Schema for a Change Event-based trigger.
changeEventTrigger [required]
object
Trigger a workflow VIA a Change Event.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 5
object
Schema for a Dashboard-based trigger.
dashboardTrigger [required]
object
Trigger a workflow VIA a Dashboard.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 6
object
Schema for a GitHub webhook-based trigger.
githubWebhookTrigger [required]
object
Trigger a workflow VIA GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 7
object
Schema for an Incident-based trigger.
incidentTrigger [required]
object
Trigger a workflow VIA an Incident. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 8
object
Schema for a Monitor-based trigger.
monitorTrigger [required]
object
Trigger a workflow VIA a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 9
object
Schema for a Schedule-based trigger.
scheduleTrigger [required]
object
Trigger a workflow VIA a Schedule. The workflow must be published.
rruleExpression [required]
string
Recurrence rule expression for scheduling.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 10
object
Schema for a Security-based trigger.
securityTrigger [required]
object
Trigger a workflow VIA a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
rateLimit
object
Defines a rate limit for a trigger.
count
int64
The TriggerRateLimitcount.
interval
string
The TriggerRateLimitinterval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 11
object
Schema for a Slack-based trigger.
slackTrigger [required]
object
Trigger a workflow VIA Slack. The workflow must be published.
startStepNames
[string]
A list of steps that run first after a trigger fires.
Option 12
object
Schema for a Workflow-based trigger.
startStepNames
[string]
A list of steps that run first after a trigger fires.
workflowTrigger [required]
object
Trigger a workflow VIA the Datadog UI. Only required if no other trigger exists.
tags
[string]
Tags of the workflow.
updatedAt
date-time
When the workflow was last updated.
webhookSecret
string
If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.
id
string
The workflow identifier
relationships
object
The definition of WorkflowDataRelationships object.
creator
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
owner
object
The definition of WorkflowUserRelationship object.
data
object
The definition of WorkflowUserRelationshipData object.
id [required]
string
The user identifier
type [required]
enum
The definition of WorkflowUserRelationshipType object.
Allowed enum values: users
type [required]
enum
The definition of WorkflowDataType object.
Allowed enum values: workflows
Delete a workflow by ID. This API requires an application key scoped with the workflows_write permission.
This endpoint requires the workflows_write permission.
List all instances of a given workflow. This API requires an application key scoped with the workflows_read permission.
This endpoint requires the workflows_read permission.
OAuth apps require the workflows_read authorization scope to access this endpoint.
引数
パスパラメーター
名前
種類
説明
workflow_id [required]
string
The ID of the workflow.
クエリ文字列
名前
種類
説明
page[size]
integer
Size for a given page. The maximum allowed value is 100.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* List workflow instances returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.WorkflowAutomationApi(configuration);constparams: v2.WorkflowAutomationApiListWorkflowInstancesRequest={workflowId:"ccf73164-1998-4785-a7a3-8d06c7e5f558",};apiInstance.listWorkflowInstances(params).then((data: v2.WorkflowListInstancesResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Execute the given workflow. This API requires an application key scoped with the workflows_run permission.
This endpoint requires the workflows_run permission.
OAuth apps require the workflows_run authorization scope to access this endpoint.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Execute a workflow returns "Created" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.WorkflowAutomationApi(configuration);constparams: v2.WorkflowAutomationApiCreateWorkflowInstanceRequest={body:{meta:{payload:{input:"value",},},},workflowId:"ccf73164-1998-4785-a7a3-8d06c7e5f558",};apiInstance.createWorkflowInstance(params).then((data: v2.WorkflowInstanceCreateResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Get a specific execution of a given workflow. This API requires an application key scoped with the workflows_read permission.
This endpoint requires the workflows_read permission.
OAuth apps require the workflows_read authorization scope to access this endpoint.
"""
Get a workflow instance returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.workflow_automation_apiimportWorkflowAutomationApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=WorkflowAutomationApi(api_client)response=api_instance.get_workflow_instance(workflow_id="ccf73164-1998-4785-a7a3-8d06c7e5f558",instance_id="305a472b-71ab-4ce8-8f8d-75db635627b5",)print(response)
# Get a workflow instance returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::WorkflowAutomationAPI.newpapi_instance.get_workflow_instance("ccf73164-1998-4785-a7a3-8d06c7e5f558","305a472b-71ab-4ce8-8f8d-75db635627b5")
// Get a workflow instance returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewWorkflowAutomationApi(apiClient)resp,r,err:=api.GetWorkflowInstance(ctx,"ccf73164-1998-4785-a7a3-8d06c7e5f558","305a472b-71ab-4ce8-8f8d-75db635627b5")iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `WorkflowAutomationApi.GetWorkflowInstance`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `WorkflowAutomationApi.GetWorkflowInstance`:\n%s\n",responseContent)}
// Get a workflow instance returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_workflow_automation::WorkflowAutomationAPI;#[tokio::main]asyncfnmain(){letconfiguration=datadog::Configuration::new();letapi=WorkflowAutomationAPI::with_config(configuration);letresp=api.get_workflow_instance("ccf73164-1998-4785-a7a3-8d06c7e5f558".to_string(),"305a472b-71ab-4ce8-8f8d-75db635627b5".to_string(),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a workflow instance returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.WorkflowAutomationApi(configuration);constparams: v2.WorkflowAutomationApiGetWorkflowInstanceRequest={workflowId:"ccf73164-1998-4785-a7a3-8d06c7e5f558",instanceId:"305a472b-71ab-4ce8-8f8d-75db635627b5",};apiInstance.getWorkflowInstance(params).then((data: v2.WorklflowGetInstanceResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Cancels a specific execution of a given workflow. This API requires an application key scoped with the workflows_run permission.
This endpoint requires the workflows_run permission.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Cancel a workflow instance returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.WorkflowAutomationApi(configuration);constparams: v2.WorkflowAutomationApiCancelWorkflowInstanceRequest={workflowId:"ccf73164-1998-4785-a7a3-8d06c7e5f558",instanceId:"305a472b-71ab-4ce8-8f8d-75db635627b5",};apiInstance.cancelWorkflowInstance(params).then((data: v2.WorklflowCancelInstanceResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
