--- title: Create a Workflow description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Workflow Automation --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Create a Workflow{% #create-a-workflow %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | --------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/workflows | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/workflows | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/workflows | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/workflows | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/workflows | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/workflows | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/workflows | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/workflows | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/workflows | ### Overview Create a new workflow, returning the workflow ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection.md#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys.md#actions-api-access). This endpoint requires the `workflows_write` permission. ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ---------------------- | ------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Data related to the workflow. | | data | attributes [*required*] | object | The definition of `WorkflowDataAttributes` object. | | attributes | createdAt | date-time | When the workflow was created. | | attributes | description | string | Description of the workflow. | | attributes | name [*required*] | string | Name of the workflow. | | attributes | 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. | | attributes | spec [*required*] | object | A complete Workflow Automation definition, including its triggers, steps, and connections. | | spec | annotations | [object] | A list of annotations used in the workflow. These are like sticky notes for your workflow! | | annotations | display [*required*] | object | The definition of `AnnotationDisplay` object. | | display | bounds | object | The definition of `AnnotationDisplayBounds` object. | | bounds | height | double | The `bounds` `height`. | | bounds | width | double | The `bounds` `width`. | | bounds | x | double | The `bounds` `x`. | | bounds | y | double | The `bounds` `y`. | | annotations | id [*required*] | string | The `Annotation` `id`. | | annotations | markdownTextAnnotation [*required*] | object | The definition of `AnnotationMarkdownTextAnnotation` object. | | markdownTextAnnotation | text | string | The `markdownTextAnnotation` `text`. | | spec | connectionEnvs | [object] | A list of connections or connection groups used in the workflow. | | connectionEnvs | connectionGroups | [object] | The `ConnectionEnv` `connectionGroups`. | | connectionGroups | connectionGroupId [*required*] | string | The `ConnectionGroup` `connectionGroupId`. | | connectionGroups | label [*required*] | string | The `ConnectionGroup` `label`. | | connectionGroups | tags [*required*] | [string] | The `ConnectionGroup` `tags`. | | connectionEnvs | connections | [object] | The `ConnectionEnv` `connections`. | | connections | connectionId [*required*] | string | The `Connection` `connectionId`. | | connections | label [*required*] | string | The `Connection` `label`. | | connectionEnvs | env [*required*] | enum | The definition of `ConnectionEnvEnv` object. Allowed enum values: `default` | | spec | handle | string | Unique identifier used to trigger workflows automatically in Datadog. | | spec | inputSchema | object | 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. }}`. | | inputSchema | parameters | [object] | The `InputSchema` `parameters`. | | parameters | allowExtraValues | boolean | The `InputSchemaParameters` `allowExtraValues`. | | parameters | allowedValues | | The `InputSchemaParameters` `allowedValues`. | | parameters | defaultValue | | The `InputSchemaParameters` `defaultValue`. | | parameters | description | string | The `InputSchemaParameters` `description`. | | parameters | label | string | The `InputSchemaParameters` `label`. | | parameters | name [*required*] | string | The `InputSchemaParameters` `name`. | | parameters | type [*required*] | enum | The definition of `InputSchemaParametersType` object. Allowed enum values: `STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT` | | spec | outputSchema | object | A list of output parameters for the workflow. | | outputSchema | parameters | [object] | The `OutputSchema` `parameters`. | | parameters | defaultValue | | The `OutputSchemaParameters` `defaultValue`. | | parameters | description | string | The `OutputSchemaParameters` `description`. | | parameters | label | string | The `OutputSchemaParameters` `label`. | | parameters | name [*required*] | string | The `OutputSchemaParameters` `name`. | | parameters | type [*required*] | enum | The definition of `OutputSchemaParametersType` object. Allowed enum values: `STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT` | | parameters | value | | The `OutputSchemaParameters` `value`. | | spec | steps | [object] | A `Step` is a sub-component of a workflow. Each `Step` performs an action. | | steps | actionId [*required*] | string | The unique identifier of an action. | | steps | completionGate | object | Used to create conditions before running subsequent actions. | | completionGate | completionCondition [*required*] | object | The definition of `CompletionCondition` object. | | completionCondition | operand1 [*required*] | | The `CompletionCondition` `operand1`. | | completionCondition | operand2 | | The `CompletionCondition` `operand2`. | | completionCondition | 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` | | completionGate | retryStrategy [*required*] | object | The definition of `RetryStrategy` object. | | retryStrategy | kind [*required*] | enum | The definition of `RetryStrategyKind` object. Allowed enum values: `RETRY_STRATEGY_LINEAR` | | retryStrategy | linear [*required*] | object | The definition of `RetryStrategyLinear` object. | | linear | interval [*required*] | string | The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | linear | maxRetries [*required*] | int32 | The `RetryStrategyLinear` `maxRetries`. | | steps | connectionLabel | string | The unique identifier of a connection defined in the spec. | | steps | display | object | The position of a step on the workflow canvas. Omit `display` from every step to use automatic layout, or provide it for every step to preserve a manual layout. | | display | bounds | object | The definition of `StepDisplayBounds` object. | | bounds | x | double | The `bounds` `x`. | | bounds | y | double | The `bounds` `y`. | | steps | errorHandlers | [object] | The `Step` `errorHandlers`. | | errorHandlers | fallbackStepName [*required*] | string | The `ErrorHandler` `fallbackStepName`. | | errorHandlers | retryStrategy [*required*] | object | The definition of `RetryStrategy` object. | | retryStrategy | kind [*required*] | enum | The definition of `RetryStrategyKind` object. Allowed enum values: `RETRY_STRATEGY_LINEAR` | | retryStrategy | linear [*required*] | object | The definition of `RetryStrategyLinear` object. | | linear | interval [*required*] | string | The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | linear | maxRetries [*required*] | int32 | The `RetryStrategyLinear` `maxRetries`. | | steps | name [*required*] | string | Name of the step. | | steps | outboundEdges | [object] | A list of subsequent actions to run. This list is empty for a terminal step. | | outboundEdges | branchName [*required*] | string | The `OutboundEdge` `branchName`. | | outboundEdges | nextStepName [*required*] | string | The `OutboundEdge` `nextStepName`. | | steps | parameters | [object] | A list of inputs for an action. | | parameters | name [*required*] | string | The `Parameter` `name`. | | parameters | value [*required*] | | The `Parameter` `value`. | | steps | readinessGate | object | Used to merge multiple branches into a single branch. | | readinessGate | thresholdType [*required*] | enum | The definition of `ReadinessGateThresholdType` object. Allowed enum values: `ANY,ALL` | | spec | triggers | [ ] | The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once. | | triggers | Object 1 | object | Schema for an agent-based trigger. | | Object 1 | agentTrigger [*required*] | object | 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. | | agentTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 1 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 2 | object | Schema for an API-based trigger. | | Object 2 | apiTrigger [*required*] | object | Trigger a workflow from an API request. The workflow must be published. | | apiTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 2 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 3 | object | Schema for an App-based trigger. | | Object 3 | appTrigger [*required*] | object | Trigger a workflow from an App. | | Object 3 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 4 | object | Schema for a Case-based trigger. | | Object 4 | caseTrigger [*required*] | object | Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published. | | caseTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 4 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 5 | object | Schema for a Change Event-based trigger. | | Object 5 | changeEventTrigger [*required*] | object | Trigger a workflow from a Change Event. | | Object 5 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 6 | object | Schema for a Database Monitoring-based trigger. | | Object 6 | databaseMonitoringTrigger [*required*] | object | Trigger a workflow from Database Monitoring. | | Object 6 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 7 | object | Schema for a Datastore-based trigger. | | Object 7 | datastoreTrigger [*required*] | object | Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published. | | datastoreTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 7 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 8 | object | Schema for a Dashboard-based trigger. | | Object 8 | dashboardTrigger [*required*] | object | Trigger a workflow from a Dashboard. | | Object 8 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 9 | object | Schema for a Form-based trigger. | | Object 9 | formTrigger [*required*] | object | Trigger a workflow from a Form. | | formTrigger | formId | string | The form UUID. | | Object 9 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 10 | object | Schema for a GitHub webhook-based trigger. | | Object 10 | githubWebhookTrigger [*required*] | object | 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. | | githubWebhookTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 10 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 11 | object | Schema for an Incident-based trigger. | | Object 11 | incidentTrigger [*required*] | object | Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published. | | incidentTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 11 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 12 | object | Schema for a Monitor-based trigger. | | Object 12 | monitorTrigger [*required*] | object | Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published. | | monitorTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 12 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 13 | object | Schema for a Notebook-based trigger. | | Object 13 | notebookTrigger [*required*] | object | Trigger a workflow from a Notebook. | | Object 13 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 14 | object | Schema for an On-Call-based trigger. | | Object 14 | onCallTrigger [*required*] | object | 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. | | onCallTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 14 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 15 | object | Schema for a Schedule-based trigger. | | Object 15 | scheduleTrigger [*required*] | object | Trigger a workflow from a Schedule. The workflow must be published. | | scheduleTrigger | overlapBehavior | enum | Controls whether a scheduled workflow run may start while another instance is still running. Allowed enum values: `EXCLUSIVE_RUN,OVERLAP_ALLOWED` | | scheduleTrigger | rruleExpression [*required*] | string | Recurrence rule expression for scheduling. | | Object 15 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 16 | object | Schema for a Security-based trigger. | | Object 16 | securityTrigger [*required*] | object | Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published. | | securityTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 16 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 17 | object | Schema for a Self Service-based trigger. | | Object 17 | selfServiceTrigger [*required*] | object | Trigger a workflow from Self Service. | | Object 17 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 18 | object | Schema for a Slack-based trigger. | | Object 18 | slackTrigger [*required*] | object | Trigger a workflow from Slack. The workflow must be published. | | Object 18 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 19 | object | Schema for a Software Catalog-based trigger. | | Object 19 | softwareCatalogTrigger [*required*] | object | Trigger a workflow from Software Catalog. | | Object 19 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 20 | object | Schema for a Workflow-based trigger. | | Object 20 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | Object 20 | workflowTrigger [*required*] | object | Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger. | | attributes | tags | [string] | Tags of the workflow. | | attributes | updatedAt | date-time | When the workflow was last updated. | | attributes | webhookSecret | string | If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here. | | data | id | string | The workflow identifier | | data | relationships | object | The definition of `WorkflowDataRelationships` object. | | relationships | creator | object | The definition of `WorkflowUserRelationship` object. | | creator | data | object | The definition of `WorkflowUserRelationshipData` object. | | data | id [*required*] | string | The user identifier | | data | type [*required*] | enum | The definition of `WorkflowUserRelationshipType` object. Allowed enum values: `users` | | relationships | owner | object | The definition of `WorkflowUserRelationship` object. | | owner | data | object | The definition of `WorkflowUserRelationshipData` object. | | data | id [*required*] | string | The user identifier | | data | type [*required*] | enum | The definition of `WorkflowUserRelationshipType` object. Allowed enum values: `users` | | data | type [*required*] | enum | The definition of `WorkflowDataType` object. Allowed enum values: `workflows` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "description": "A sample workflow.", "name": "Example Workflow", "published": true, "spec": { "connectionEnvs": [ { "connections": [ { "connectionId": "e1e64943-c7c5-4487-aece-25aaec7d3aad", "label": "INTEGRATION_DATADOG" } ], "env": "default" } ], "inputSchema": { "parameters": [ { "defaultValue": "default", "name": "input", "type": "STRING" } ] }, "outputSchema": { "parameters": [ { "name": "output", "type": "ARRAY_OBJECT", "value": "outputValue" } ] }, "steps": [ { "actionId": "com.datadoghq.dd.monitor.listMonitors", "connectionLabel": "INTEGRATION_DATADOG", "name": "Step1", "outboundEdges": [ { "branchName": "main", "nextStepName": "Step2" } ], "parameters": [ { "name": "tags", "value": "service:monitoring" } ] }, { "actionId": "com.datadoghq.core.noop", "name": "Step2" } ], "triggers": [ { "monitorTrigger": { "rateLimit": { "count": 1, "interval": "3600s" } }, "startStepNames": [ "Step1" ] }, { "startStepNames": [ "Step1" ], "githubWebhookTrigger": {} } ] }, "tags": [ "team:infra", "service:monitoring", "foo:bar" ] }, "type": "workflows" } } ``` {% /tab %} ### Response {% tab title="201" %} Successfully created a workflow. {% tab title="Model" %} The response object after creating a new workflow. | Parent field | Field | Type | Description | | ---------------------- | ------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Data related to the workflow. | | data | attributes [*required*] | object | The definition of `WorkflowDataAttributes` object. | | attributes | createdAt | date-time | When the workflow was created. | | attributes | description | string | Description of the workflow. | | attributes | name [*required*] | string | Name of the workflow. | | attributes | 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. | | attributes | spec [*required*] | object | A complete Workflow Automation definition, including its triggers, steps, and connections. | | spec | annotations | [object] | A list of annotations used in the workflow. These are like sticky notes for your workflow! | | annotations | display [*required*] | object | The definition of `AnnotationDisplay` object. | | display | bounds | object | The definition of `AnnotationDisplayBounds` object. | | bounds | height | double | The `bounds` `height`. | | bounds | width | double | The `bounds` `width`. | | bounds | x | double | The `bounds` `x`. | | bounds | y | double | The `bounds` `y`. | | annotations | id [*required*] | string | The `Annotation` `id`. | | annotations | markdownTextAnnotation [*required*] | object | The definition of `AnnotationMarkdownTextAnnotation` object. | | markdownTextAnnotation | text | string | The `markdownTextAnnotation` `text`. | | spec | connectionEnvs | [object] | A list of connections or connection groups used in the workflow. | | connectionEnvs | connectionGroups | [object] | The `ConnectionEnv` `connectionGroups`. | | connectionGroups | connectionGroupId [*required*] | string | The `ConnectionGroup` `connectionGroupId`. | | connectionGroups | label [*required*] | string | The `ConnectionGroup` `label`. | | connectionGroups | tags [*required*] | [string] | The `ConnectionGroup` `tags`. | | connectionEnvs | connections | [object] | The `ConnectionEnv` `connections`. | | connections | connectionId [*required*] | string | The `Connection` `connectionId`. | | connections | label [*required*] | string | The `Connection` `label`. | | connectionEnvs | env [*required*] | enum | The definition of `ConnectionEnvEnv` object. Allowed enum values: `default` | | spec | handle | string | Unique identifier used to trigger workflows automatically in Datadog. | | spec | inputSchema | object | 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. }}`. | | inputSchema | parameters | [object] | The `InputSchema` `parameters`. | | parameters | allowExtraValues | boolean | The `InputSchemaParameters` `allowExtraValues`. | | parameters | allowedValues | | The `InputSchemaParameters` `allowedValues`. | | parameters | defaultValue | | The `InputSchemaParameters` `defaultValue`. | | parameters | description | string | The `InputSchemaParameters` `description`. | | parameters | label | string | The `InputSchemaParameters` `label`. | | parameters | name [*required*] | string | The `InputSchemaParameters` `name`. | | parameters | type [*required*] | enum | The definition of `InputSchemaParametersType` object. Allowed enum values: `STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT` | | spec | outputSchema | object | A list of output parameters for the workflow. | | outputSchema | parameters | [object] | The `OutputSchema` `parameters`. | | parameters | defaultValue | | The `OutputSchemaParameters` `defaultValue`. | | parameters | description | string | The `OutputSchemaParameters` `description`. | | parameters | label | string | The `OutputSchemaParameters` `label`. | | parameters | name [*required*] | string | The `OutputSchemaParameters` `name`. | | parameters | type [*required*] | enum | The definition of `OutputSchemaParametersType` object. Allowed enum values: `STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT` | | parameters | value | | The `OutputSchemaParameters` `value`. | | spec | steps | [object] | A `Step` is a sub-component of a workflow. Each `Step` performs an action. | | steps | actionId [*required*] | string | The unique identifier of an action. | | steps | completionGate | object | Used to create conditions before running subsequent actions. | | completionGate | completionCondition [*required*] | object | The definition of `CompletionCondition` object. | | completionCondition | operand1 [*required*] | | The `CompletionCondition` `operand1`. | | completionCondition | operand2 | | The `CompletionCondition` `operand2`. | | completionCondition | 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` | | completionGate | retryStrategy [*required*] | object | The definition of `RetryStrategy` object. | | retryStrategy | kind [*required*] | enum | The definition of `RetryStrategyKind` object. Allowed enum values: `RETRY_STRATEGY_LINEAR` | | retryStrategy | linear [*required*] | object | The definition of `RetryStrategyLinear` object. | | linear | interval [*required*] | string | The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | linear | maxRetries [*required*] | int32 | The `RetryStrategyLinear` `maxRetries`. | | steps | connectionLabel | string | The unique identifier of a connection defined in the spec. | | steps | display | object | The position of a step on the workflow canvas. Omit `display` from every step to use automatic layout, or provide it for every step to preserve a manual layout. | | display | bounds | object | The definition of `StepDisplayBounds` object. | | bounds | x | double | The `bounds` `x`. | | bounds | y | double | The `bounds` `y`. | | steps | errorHandlers | [object] | The `Step` `errorHandlers`. | | errorHandlers | fallbackStepName [*required*] | string | The `ErrorHandler` `fallbackStepName`. | | errorHandlers | retryStrategy [*required*] | object | The definition of `RetryStrategy` object. | | retryStrategy | kind [*required*] | enum | The definition of `RetryStrategyKind` object. Allowed enum values: `RETRY_STRATEGY_LINEAR` | | retryStrategy | linear [*required*] | object | The definition of `RetryStrategyLinear` object. | | linear | interval [*required*] | string | The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | linear | maxRetries [*required*] | int32 | The `RetryStrategyLinear` `maxRetries`. | | steps | name [*required*] | string | Name of the step. | | steps | outboundEdges | [object] | A list of subsequent actions to run. This list is empty for a terminal step. | | outboundEdges | branchName [*required*] | string | The `OutboundEdge` `branchName`. | | outboundEdges | nextStepName [*required*] | string | The `OutboundEdge` `nextStepName`. | | steps | parameters | [object] | A list of inputs for an action. | | parameters | name [*required*] | string | The `Parameter` `name`. | | parameters | value [*required*] | | The `Parameter` `value`. | | steps | readinessGate | object | Used to merge multiple branches into a single branch. | | readinessGate | thresholdType [*required*] | enum | The definition of `ReadinessGateThresholdType` object. Allowed enum values: `ANY,ALL` | | spec | triggers | [ ] | The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once. | | triggers | Object 1 | object | Schema for an agent-based trigger. | | Object 1 | agentTrigger [*required*] | object | 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. | | agentTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 1 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 2 | object | Schema for an API-based trigger. | | Object 2 | apiTrigger [*required*] | object | Trigger a workflow from an API request. The workflow must be published. | | apiTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 2 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 3 | object | Schema for an App-based trigger. | | Object 3 | appTrigger [*required*] | object | Trigger a workflow from an App. | | Object 3 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 4 | object | Schema for a Case-based trigger. | | Object 4 | caseTrigger [*required*] | object | Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published. | | caseTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 4 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 5 | object | Schema for a Change Event-based trigger. | | Object 5 | changeEventTrigger [*required*] | object | Trigger a workflow from a Change Event. | | Object 5 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 6 | object | Schema for a Database Monitoring-based trigger. | | Object 6 | databaseMonitoringTrigger [*required*] | object | Trigger a workflow from Database Monitoring. | | Object 6 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 7 | object | Schema for a Datastore-based trigger. | | Object 7 | datastoreTrigger [*required*] | object | Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published. | | datastoreTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 7 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 8 | object | Schema for a Dashboard-based trigger. | | Object 8 | dashboardTrigger [*required*] | object | Trigger a workflow from a Dashboard. | | Object 8 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 9 | object | Schema for a Form-based trigger. | | Object 9 | formTrigger [*required*] | object | Trigger a workflow from a Form. | | formTrigger | formId | string | The form UUID. | | Object 9 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 10 | object | Schema for a GitHub webhook-based trigger. | | Object 10 | githubWebhookTrigger [*required*] | object | 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. | | githubWebhookTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 10 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 11 | object | Schema for an Incident-based trigger. | | Object 11 | incidentTrigger [*required*] | object | Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published. | | incidentTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 11 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 12 | object | Schema for a Monitor-based trigger. | | Object 12 | monitorTrigger [*required*] | object | Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published. | | monitorTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 12 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 13 | object | Schema for a Notebook-based trigger. | | Object 13 | notebookTrigger [*required*] | object | Trigger a workflow from a Notebook. | | Object 13 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 14 | object | Schema for an On-Call-based trigger. | | Object 14 | onCallTrigger [*required*] | object | 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. | | onCallTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 14 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 15 | object | Schema for a Schedule-based trigger. | | Object 15 | scheduleTrigger [*required*] | object | Trigger a workflow from a Schedule. The workflow must be published. | | scheduleTrigger | overlapBehavior | enum | Controls whether a scheduled workflow run may start while another instance is still running. Allowed enum values: `EXCLUSIVE_RUN,OVERLAP_ALLOWED` | | scheduleTrigger | rruleExpression [*required*] | string | Recurrence rule expression for scheduling. | | Object 15 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 16 | object | Schema for a Security-based trigger. | | Object 16 | securityTrigger [*required*] | object | Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published. | | securityTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 16 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 17 | object | Schema for a Self Service-based trigger. | | Object 17 | selfServiceTrigger [*required*] | object | Trigger a workflow from Self Service. | | Object 17 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 18 | object | Schema for a Slack-based trigger. | | Object 18 | slackTrigger [*required*] | object | Trigger a workflow from Slack. The workflow must be published. | | Object 18 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 19 | object | Schema for a Software Catalog-based trigger. | | Object 19 | softwareCatalogTrigger [*required*] | object | Trigger a workflow from Software Catalog. | | Object 19 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 20 | object | Schema for a Workflow-based trigger. | | Object 20 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | Object 20 | workflowTrigger [*required*] | object | Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger. | | attributes | tags | [string] | Tags of the workflow. | | attributes | updatedAt | date-time | When the workflow was last updated. | | attributes | webhookSecret | string | If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here. | | data | id | string | The workflow identifier | | data | relationships | object | The definition of `WorkflowDataRelationships` object. | | relationships | creator | object | The definition of `WorkflowUserRelationship` object. | | creator | data | object | The definition of `WorkflowUserRelationshipData` object. | | data | id [*required*] | string | The user identifier | | data | type [*required*] | enum | The definition of `WorkflowUserRelationshipType` object. Allowed enum values: `users` | | relationships | owner | object | The definition of `WorkflowUserRelationship` object. | | owner | data | object | The definition of `WorkflowUserRelationshipData` object. | | data | id [*required*] | string | The user identifier | | data | type [*required*] | enum | The definition of `WorkflowUserRelationshipType` object. Allowed enum values: `users` | | data | type [*required*] | enum | The definition of `WorkflowDataType` object. Allowed enum values: `workflows` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "createdAt": "2019-09-19T10:00:00.000Z", "description": "string", "name": "", "published": false, "spec": { "annotations": [ { "display": { "bounds": { "height": "number", "width": "number", "x": "number", "y": "number" } }, "id": "", "markdownTextAnnotation": { "text": "string" } } ], "connectionEnvs": [ { "connectionGroups": [ { "connectionGroupId": "", "label": "", "tags": [ "" ] } ], "connections": [ { "connectionId": "", "label": "" } ], "env": "default" } ], "handle": "string", "inputSchema": { "parameters": [ { "allowExtraValues": false, "allowedValues": "undefined", "defaultValue": "undefined", "description": "string", "label": "string", "name": "", "type": "STRING" } ] }, "outputSchema": { "parameters": [ { "defaultValue": "undefined", "description": "string", "label": "string", "name": "", "type": "STRING", "value": "undefined" } ] }, "steps": [ { "actionId": "", "completionGate": { "completionCondition": { "operand1": "undefined", "operand2": "undefined", "operator": "OPERATOR_EQUAL" }, "retryStrategy": { "kind": "RETRY_STRATEGY_LINEAR", "linear": { "interval": "", "maxRetries": 0 } } }, "connectionLabel": "string", "display": { "bounds": { "x": "number", "y": "number" } }, "errorHandlers": [ { "fallbackStepName": "", "retryStrategy": { "kind": "RETRY_STRATEGY_LINEAR", "linear": { "interval": "", "maxRetries": 0 } } } ], "name": "", "outboundEdges": [ { "branchName": "main", "nextStepName": "Step2" } ], "parameters": [ { "name": "", "value": "undefined" } ], "readinessGate": { "thresholdType": "ANY" } } ], "triggers": [ { "agentTrigger": { "rateLimit": { "count": "integer", "interval": "string" } }, "startStepNames": [ "" ] } ] }, "tags": [], "updatedAt": "2019-09-19T10:00:00.000Z", "webhookSecret": "string" }, "id": "string", "relationships": { "creator": { "data": { "id": "", "type": "users" } }, "owner": { "data": { "id": "", "type": "users" } } }, "type": "workflows" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/workflows" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "description": "A sample workflow.", "name": "Example Workflow", "published": true, "spec": { "annotations": [ { "display": { "bounds": { "height": 150, "width": 300, "x": -375, "y": -0.5 } }, "id": "99999999-9999-9999-9999-999999999999", "markdownTextAnnotation": { "text": "Example annotation." } } ], "connectionEnvs": [ { "connections": [ { "connectionId": "e1e64943-c7c5-4487-aece-25aaec7d3aad", "label": "INTEGRATION_DATADOG" } ], "env": "default" } ], "handle": "my-handle", "inputSchema": { "parameters": [ { "defaultValue": "default", "name": "input", "type": "STRING" } ] }, "outputSchema": { "parameters": [ { "name": "output", "type": "ARRAY_OBJECT", "value": "{{ Steps.Step1 }}" } ] }, "steps": [ { "actionId": "com.datadoghq.dd.monitor.listMonitors", "connectionLabel": "INTEGRATION_DATADOG", "name": "Step1", "outboundEdges": [ { "branchName": "main", "nextStepName": "Step2" } ], "parameters": [ { "name": "tags", "value": "service:monitoring" } ] }, { "actionId": "com.datadoghq.core.noop", "name": "Step2" } ], "triggers": [ { "monitorTrigger": { "rateLimit": { "count": 1, "interval": "3600s" } }, "startStepNames": [ "Step1" ] }, { "githubWebhookTrigger": {}, "startStepNames": [ "Step1" ] } ] }, "tags": [ "team:infra", "service:monitoring" ] }, "type": "workflows" } } EOF ##### ```go // Create a Workflow returns "Successfully created a workflow." response package main import ( "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" ) func main() { body := datadogV2.CreateWorkflowRequest{ Data: datadogV2.WorkflowData{ Attributes: datadogV2.WorkflowDataAttributes{ Description: datadog.PtrString("A sample workflow."), Name: "Example Workflow", Published: datadog.PtrBool(true), Spec: datadogV2.Spec{ ConnectionEnvs: []datadogV2.ConnectionEnv{ { Connections: []datadogV2.Connection{ { ConnectionId: "e1e64943-c7c5-4487-aece-25aaec7d3aad", Label: "INTEGRATION_DATADOG", }, }, Env: datadogV2.CONNECTIONENVENV_DEFAULT, }, }, InputSchema: &datadogV2.InputSchema{ Parameters: []datadogV2.InputSchemaParameters{ { DefaultValue: "default", Name: "input", Type: datadogV2.INPUTSCHEMAPARAMETERSTYPE_STRING, }, }, }, OutputSchema: &datadogV2.OutputSchema{ Parameters: []datadogV2.OutputSchemaParameters{ { Name: "output", Type: datadogV2.OUTPUTSCHEMAPARAMETERSTYPE_ARRAY_OBJECT, Value: "outputValue", }, }, }, Steps: []datadogV2.Step{ { ActionId: "com.datadoghq.dd.monitor.listMonitors", ConnectionLabel: datadog.PtrString("INTEGRATION_DATADOG"), Name: "Step1", OutboundEdges: []datadogV2.OutboundEdge{ { BranchName: "main", NextStepName: "Step2", }, }, Parameters: []datadogV2.Parameter{ { Name: "tags", Value: "service:monitoring", }, }, }, { ActionId: "com.datadoghq.core.noop", Name: "Step2", }, }, Triggers: []datadogV2.Trigger{ datadogV2.Trigger{ MonitorTriggerWrapper: &datadogV2.MonitorTriggerWrapper{ MonitorTrigger: datadogV2.MonitorTrigger{ RateLimit: &datadogV2.TriggerRateLimit{ Count: datadog.PtrInt64(1), Interval: datadog.PtrString("3600s"), }, }, StartStepNames: []string{ "Step1", }, }}, datadogV2.Trigger{ GithubWebhookTriggerWrapper: &datadogV2.GithubWebhookTriggerWrapper{ StartStepNames: []string{ "Step1", }, GithubWebhookTrigger: datadogV2.GithubWebhookTrigger{}, }}, }, }, Tags: []string{ "team:infra", "service:monitoring", "foo:bar", }, }, Type: datadogV2.WORKFLOWDATATYPE_WORKFLOWS, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewWorkflowAutomationApi(apiClient) resp, r, err := api.CreateWorkflow(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `WorkflowAutomationApi.CreateWorkflow`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `WorkflowAutomationApi.CreateWorkflow`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create a Workflow returns "Successfully created a workflow." response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.WorkflowAutomationApi; import com.datadog.api.client.v2.model.Connection; import com.datadog.api.client.v2.model.ConnectionEnv; import com.datadog.api.client.v2.model.ConnectionEnvEnv; import com.datadog.api.client.v2.model.CreateWorkflowRequest; import com.datadog.api.client.v2.model.CreateWorkflowResponse; import com.datadog.api.client.v2.model.GithubWebhookTrigger; import com.datadog.api.client.v2.model.GithubWebhookTriggerWrapper; import com.datadog.api.client.v2.model.InputSchema; import com.datadog.api.client.v2.model.InputSchemaParameters; import com.datadog.api.client.v2.model.InputSchemaParametersType; import com.datadog.api.client.v2.model.MonitorTrigger; import com.datadog.api.client.v2.model.MonitorTriggerWrapper; import com.datadog.api.client.v2.model.OutboundEdge; import com.datadog.api.client.v2.model.OutputSchema; import com.datadog.api.client.v2.model.OutputSchemaParameters; import com.datadog.api.client.v2.model.OutputSchemaParametersType; import com.datadog.api.client.v2.model.Parameter; import com.datadog.api.client.v2.model.Spec; import com.datadog.api.client.v2.model.Step; import com.datadog.api.client.v2.model.Trigger; import com.datadog.api.client.v2.model.TriggerRateLimit; import com.datadog.api.client.v2.model.WorkflowData; import com.datadog.api.client.v2.model.WorkflowDataAttributes; import com.datadog.api.client.v2.model.WorkflowDataType; import java.util.Arrays; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); WorkflowAutomationApi apiInstance = new WorkflowAutomationApi(defaultClient); CreateWorkflowRequest body = new CreateWorkflowRequest() .data( new WorkflowData() .attributes( new WorkflowDataAttributes() .description("A sample workflow.") .name("Example Workflow") .published(true) .spec( new Spec() .connectionEnvs( Collections.singletonList( new ConnectionEnv() .connections( Collections.singletonList( new Connection() .connectionId( "e1e64943-c7c5-4487-aece-25aaec7d3aad") .label("INTEGRATION_DATADOG"))) .env(ConnectionEnvEnv.DEFAULT))) .inputSchema( new InputSchema() .parameters( Collections.singletonList( new InputSchemaParameters() .defaultValue("default") .name("input") .type(InputSchemaParametersType.STRING)))) .outputSchema( new OutputSchema() .parameters( Collections.singletonList( new OutputSchemaParameters() .name("output") .type( OutputSchemaParametersType.ARRAY_OBJECT) .value("outputValue")))) .steps( Arrays.asList( new Step() .actionId("com.datadoghq.dd.monitor.listMonitors") .connectionLabel("INTEGRATION_DATADOG") .name("Step1") .outboundEdges( Collections.singletonList( new OutboundEdge() .branchName("main") .nextStepName("Step2"))) .parameters( Collections.singletonList( new Parameter() .name("tags") .value("service:monitoring"))), new Step() .actionId("com.datadoghq.core.noop") .name("Step2"))) .triggers( Arrays.asList( new Trigger( new MonitorTriggerWrapper() .monitorTrigger( new MonitorTrigger() .rateLimit( new TriggerRateLimit() .count(1L) .interval("3600s"))) .startStepNames( Collections.singletonList("Step1"))), new Trigger( new GithubWebhookTriggerWrapper() .startStepNames( Collections.singletonList("Step1")) .githubWebhookTrigger( new GithubWebhookTrigger()))))) .tags(Arrays.asList("team:infra", "service:monitoring", "foo:bar"))) .type(WorkflowDataType.WORKFLOWS)); try { CreateWorkflowResponse result = apiInstance.createWorkflow(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling WorkflowAutomationApi#createWorkflow"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Create a Workflow returns "Successfully created a workflow." response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.workflow_automation_api import WorkflowAutomationApi from datadog_api_client.v2.model.connection import Connection from datadog_api_client.v2.model.connection_env import ConnectionEnv from datadog_api_client.v2.model.connection_env_env import ConnectionEnvEnv from datadog_api_client.v2.model.create_workflow_request import CreateWorkflowRequest from datadog_api_client.v2.model.github_webhook_trigger import GithubWebhookTrigger from datadog_api_client.v2.model.github_webhook_trigger_wrapper import GithubWebhookTriggerWrapper from datadog_api_client.v2.model.input_schema import InputSchema from datadog_api_client.v2.model.input_schema_parameters import InputSchemaParameters from datadog_api_client.v2.model.input_schema_parameters_type import InputSchemaParametersType from datadog_api_client.v2.model.monitor_trigger import MonitorTrigger from datadog_api_client.v2.model.monitor_trigger_wrapper import MonitorTriggerWrapper from datadog_api_client.v2.model.outbound_edge import OutboundEdge from datadog_api_client.v2.model.output_schema import OutputSchema from datadog_api_client.v2.model.output_schema_parameters import OutputSchemaParameters from datadog_api_client.v2.model.output_schema_parameters_type import OutputSchemaParametersType from datadog_api_client.v2.model.parameter import Parameter from datadog_api_client.v2.model.spec import Spec from datadog_api_client.v2.model.step import Step from datadog_api_client.v2.model.trigger_rate_limit import TriggerRateLimit from datadog_api_client.v2.model.workflow_data import WorkflowData from datadog_api_client.v2.model.workflow_data_attributes import WorkflowDataAttributes from datadog_api_client.v2.model.workflow_data_type import WorkflowDataType body = CreateWorkflowRequest( data=WorkflowData( attributes=WorkflowDataAttributes( description="A sample workflow.", name="Example Workflow", published=True, spec=Spec( connection_envs=[ ConnectionEnv( connections=[ Connection( connection_id="e1e64943-c7c5-4487-aece-25aaec7d3aad", label="INTEGRATION_DATADOG", ), ], env=ConnectionEnvEnv.DEFAULT, ), ], input_schema=InputSchema( parameters=[ InputSchemaParameters( default_value="default", name="input", type=InputSchemaParametersType.STRING, ), ], ), output_schema=OutputSchema( parameters=[ OutputSchemaParameters( name="output", type=OutputSchemaParametersType.ARRAY_OBJECT, value="outputValue", ), ], ), steps=[ Step( action_id="com.datadoghq.dd.monitor.listMonitors", connection_label="INTEGRATION_DATADOG", name="Step1", outbound_edges=[ OutboundEdge( branch_name="main", next_step_name="Step2", ), ], parameters=[ Parameter( name="tags", value="service:monitoring", ), ], ), Step( action_id="com.datadoghq.core.noop", name="Step2", ), ], triggers=[ MonitorTriggerWrapper( monitor_trigger=MonitorTrigger( rate_limit=TriggerRateLimit( count=1, interval="3600s", ), ), start_step_names=[ "Step1", ], ), GithubWebhookTriggerWrapper( start_step_names=[ "Step1", ], github_webhook_trigger=GithubWebhookTrigger(), ), ], ), tags=[ "team:infra", "service:monitoring", "foo:bar", ], ), type=WorkflowDataType.WORKFLOWS, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = WorkflowAutomationApi(api_client) response = api_instance.create_workflow(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Create a Workflow returns "Successfully created a workflow." response require "datadog_api_client" api_instance = DatadogAPIClient::V2::WorkflowAutomationAPI.new body = DatadogAPIClient::V2::CreateWorkflowRequest.new({ data: DatadogAPIClient::V2::WorkflowData.new({ attributes: DatadogAPIClient::V2::WorkflowDataAttributes.new({ description: "A sample workflow.", name: "Example Workflow", published: true, spec: DatadogAPIClient::V2::Spec.new({ connection_envs: [ DatadogAPIClient::V2::ConnectionEnv.new({ connections: [ DatadogAPIClient::V2::Connection.new({ connection_id: "e1e64943-c7c5-4487-aece-25aaec7d3aad", label: "INTEGRATION_DATADOG", }), ], env: DatadogAPIClient::V2::ConnectionEnvEnv::DEFAULT, }), ], input_schema: DatadogAPIClient::V2::InputSchema.new({ parameters: [ DatadogAPIClient::V2::InputSchemaParameters.new({ default_value: "default", name: "input", type: DatadogAPIClient::V2::InputSchemaParametersType::STRING, }), ], }), output_schema: DatadogAPIClient::V2::OutputSchema.new({ parameters: [ DatadogAPIClient::V2::OutputSchemaParameters.new({ name: "output", type: DatadogAPIClient::V2::OutputSchemaParametersType::ARRAY_OBJECT, value: "outputValue", }), ], }), steps: [ DatadogAPIClient::V2::Step.new({ action_id: "com.datadoghq.dd.monitor.listMonitors", connection_label: "INTEGRATION_DATADOG", name: "Step1", outbound_edges: [ DatadogAPIClient::V2::OutboundEdge.new({ branch_name: "main", next_step_name: "Step2", }), ], parameters: [ DatadogAPIClient::V2::Parameter.new({ name: "tags", value: "service:monitoring", }), ], }), DatadogAPIClient::V2::Step.new({ action_id: "com.datadoghq.core.noop", name: "Step2", }), ], triggers: [ DatadogAPIClient::V2::MonitorTriggerWrapper.new({ monitor_trigger: DatadogAPIClient::V2::MonitorTrigger.new({ rate_limit: DatadogAPIClient::V2::TriggerRateLimit.new({ count: 1, interval: "3600s", }), }), start_step_names: [ "Step1", ], }), DatadogAPIClient::V2::GithubWebhookTriggerWrapper.new({ start_step_names: [ "Step1", ], github_webhook_trigger: DatadogAPIClient::V2::GithubWebhookTrigger.new({}), }), ], }), tags: [ "team:infra", "service:monitoring", "foo:bar", ], }), type: DatadogAPIClient::V2::WorkflowDataType::WORKFLOWS, }), }) p api_instance.create_workflow(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Create a Workflow returns "Successfully created a workflow." response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_workflow_automation::WorkflowAutomationAPI; use datadog_api_client::datadogV2::model::Connection; use datadog_api_client::datadogV2::model::ConnectionEnv; use datadog_api_client::datadogV2::model::ConnectionEnvEnv; use datadog_api_client::datadogV2::model::CreateWorkflowRequest; use datadog_api_client::datadogV2::model::GithubWebhookTrigger; use datadog_api_client::datadogV2::model::GithubWebhookTriggerWrapper; use datadog_api_client::datadogV2::model::InputSchema; use datadog_api_client::datadogV2::model::InputSchemaParameters; use datadog_api_client::datadogV2::model::InputSchemaParametersType; use datadog_api_client::datadogV2::model::MonitorTrigger; use datadog_api_client::datadogV2::model::MonitorTriggerWrapper; use datadog_api_client::datadogV2::model::OutboundEdge; use datadog_api_client::datadogV2::model::OutputSchema; use datadog_api_client::datadogV2::model::OutputSchemaParameters; use datadog_api_client::datadogV2::model::OutputSchemaParametersType; use datadog_api_client::datadogV2::model::Parameter; use datadog_api_client::datadogV2::model::Spec; use datadog_api_client::datadogV2::model::Step; use datadog_api_client::datadogV2::model::Trigger; use datadog_api_client::datadogV2::model::TriggerRateLimit; use datadog_api_client::datadogV2::model::WorkflowData; use datadog_api_client::datadogV2::model::WorkflowDataAttributes; use datadog_api_client::datadogV2::model::WorkflowDataType; use serde_json::Value; #[tokio::main] async fn main() { let body = CreateWorkflowRequest::new(WorkflowData::new( WorkflowDataAttributes::new( "Example Workflow".to_string(), Spec::new() .connection_envs(vec![ConnectionEnv::new(ConnectionEnvEnv::DEFAULT) .connections(vec![Connection::new( "e1e64943-c7c5-4487-aece-25aaec7d3aad".to_string(), "INTEGRATION_DATADOG".to_string(), )])]) .input_schema(InputSchema::new().parameters(vec![ InputSchemaParameters::new( "input".to_string(), InputSchemaParametersType::STRING, ).default_value(Value::from("default")) ])) .output_schema(OutputSchema::new().parameters(vec![ OutputSchemaParameters::new( "output".to_string(), OutputSchemaParametersType::ARRAY_OBJECT, ).value(Value::from("outputValue")) ])) .steps(vec![ Step::new( "com.datadoghq.dd.monitor.listMonitors".to_string(), "Step1".to_string(), ) .connection_label("INTEGRATION_DATADOG".to_string()) .outbound_edges(vec![OutboundEdge::new( "main".to_string(), "Step2".to_string(), )]) .parameters(vec![Parameter::new( "tags".to_string(), Value::from("service:monitoring"), )]), Step::new("com.datadoghq.core.noop".to_string(), "Step2".to_string()), ]) .triggers(vec![ Trigger::MonitorTriggerWrapper(Box::new( MonitorTriggerWrapper::new( MonitorTrigger::new().rate_limit( TriggerRateLimit::new() .count(1) .interval("3600s".to_string()), ), ) .start_step_names(vec!["Step1".to_string()]), )), Trigger::GithubWebhookTriggerWrapper(Box::new( GithubWebhookTriggerWrapper::new(GithubWebhookTrigger::new()) .start_step_names(vec!["Step1".to_string()]), )), ]), ) .description("A sample workflow.".to_string()) .published(true) .tags(vec![ "team:infra".to_string(), "service:monitoring".to_string(), "foo:bar".to_string(), ]), WorkflowDataType::WORKFLOWS, )); let configuration = datadog::Configuration::new(); let api = WorkflowAutomationAPI::with_config(configuration); let resp = api.create_workflow(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create a Workflow returns "Successfully created a workflow." response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.WorkflowAutomationApi(configuration); const params: v2.WorkflowAutomationApiCreateWorkflowRequest = { body: { data: { attributes: { description: "A sample workflow.", name: "Example Workflow", published: true, spec: { connectionEnvs: [ { connections: [ { connectionId: "e1e64943-c7c5-4487-aece-25aaec7d3aad", label: "INTEGRATION_DATADOG", }, ], env: "default", }, ], inputSchema: { parameters: [ { defaultValue: "default", name: "input", type: "STRING", }, ], }, outputSchema: { parameters: [ { name: "output", type: "ARRAY_OBJECT", value: "outputValue", }, ], }, steps: [ { actionId: "com.datadoghq.dd.monitor.listMonitors", connectionLabel: "INTEGRATION_DATADOG", name: "Step1", outboundEdges: [ { branchName: "main", nextStepName: "Step2", }, ], parameters: [ { name: "tags", value: "service:monitoring", }, ], }, { actionId: "com.datadoghq.core.noop", name: "Step2", }, ], triggers: [ { monitorTrigger: { rateLimit: { count: 1, interval: "3600s", }, }, startStepNames: ["Step1"], }, { startStepNames: ["Step1"], githubWebhookTrigger: {}, }, ], }, tags: ["team:infra", "service:monitoring", "foo:bar"], }, type: "workflows", }, }, }; apiInstance .createWorkflow(params) .then((data: v2.CreateWorkflowResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}