Datadog Workflows API

The Workflows API from Datadog — 7 operation(s) for workflows.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

datadog-workflows-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  contact:
    email: support@datadoghq.com
    name: Datadog Support
    url: https://www.datadoghq.com/support/
  description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically.
  title: Datadog Account Workflows API
  version: '1.0'
servers:
- url: https://{subdomain}.{site}
  variables:
    site:
      default: datadoghq.com
      description: The regional site for Datadog customers.
      enum:
      - datadoghq.com
      - us3.datadoghq.com
      - us5.datadoghq.com
      - ap1.datadoghq.com
      - datadoghq.eu
      - ddog-gov.com
    subdomain:
      default: api
      description: The subdomain where the API is deployed.
- url: '{protocol}://{name}'
  variables:
    name:
      default: api.datadoghq.com
      description: Full site DNS name.
    protocol:
      default: https
      description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
  variables:
    site:
      default: datadoghq.com
      description: Any Datadog deployment.
    subdomain:
      default: api
      description: The subdomain where the API is deployed.
security:
- apiKeyAuth: []
  appKeyAuth: []
tags:
- name: Workflows
paths:
  /api/v2/integration/ms-teams/configuration/workflows-webhook-handles:
    get:
      description: Get a list of all Workflows webhook handles from the Datadog Microsoft Teams integration.
      operationId: ListWorkflowsWebhookHandles
      parameters:
      - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleNameQueryParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '412':
          $ref: '#/components/responses/PreconditionFailedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Get All Workflows Webhook Handles
      tags:
      - Workflows
      x-menu-order: 1
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      description: Create a Workflows webhook handle in the Datadog Microsoft Teams integration.
      operationId: CreateWorkflowsWebhookHandle
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MicrosoftTeamsCreateWorkflowsWebhookHandleRequest'
        description: Workflows Webhook handle payload.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse'
          description: CREATED
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '409':
          $ref: '#/components/responses/ConflictResponse'
        '412':
          $ref: '#/components/responses/PreconditionFailedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Create Workflows Webhook Handle
      tags:
      - Workflows
      x-codegen-request-body-name: body
      x-given:
        workflows_webhook_handle:
          parameters:
          - name: body
            value: "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"{{ unique }}\",\n      \"url\": \"https://prod-100.westus.logic.azure.com:443/workflows/abcd1234\"\n     },\n     \"type\": \"workflows-webhook-handle\"\n  }\n}"
          step: there is a valid "workflows_webhook_handle" in the system
      x-menu-order: 1
      x-undo:
        operationId: DeleteWorkflowsWebhookHandle
        parameters:
        - name: handle_id
          source: data.id
        type: unsafe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/integration/ms-teams/configuration/workflows-webhook-handles/{handle_id}:
    delete:
      description: Delete a Workflows webhook handle from the Datadog Microsoft Teams integration.
      operationId: DeleteWorkflowsWebhookHandle
      parameters:
      - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter'
      responses:
        '204':
          description: OK
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '412':
          $ref: '#/components/responses/PreconditionFailedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Delete Workflows Webhook Handle
      tags:
      - Workflows
      x-menu-order: 1
      x-undo:
        type: idempotent
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: Get the name of a Workflows webhook handle from the Datadog Microsoft Teams integration.
      operationId: GetWorkflowsWebhookHandle
      parameters:
      - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '412':
          $ref: '#/components/responses/PreconditionFailedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Get Workflows Webhook Handle Information
      tags:
      - Workflows
      x-menu-order: 1
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      description: Update a Workflows webhook handle from the Datadog Microsoft Teams integration.
      operationId: UpdateWorkflowsWebhookHandle
      parameters:
      - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest'
        description: Workflows Webhook handle payload.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '409':
          $ref: '#/components/responses/ConflictResponse'
        '412':
          $ref: '#/components/responses/PreconditionFailedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Update Workflows Webhook Handle
      tags:
      - Workflows
      x-codegen-request-body-name: body
      x-menu-order: 1
      x-undo:
        type: idempotent
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/workflows:
    post:
      description: Create a new workflow, returning the workflow ID. This API requires an application key scoped with the `workflows_write` permission.
      operationId: CreateWorkflow
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkflowRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkflowResponse'
          description: Successfully created a workflow.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Forbidden
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Too many requests
      summary: Datadog Create a Workflow
      tags:
      - Workflows
      x-given:
        workflow:
          parameters:
          - name: body
            value: "{\n  \"data\": {\n    \"type\": \"workflows\",\n    \"attributes\": {\n        \"name\": \"Cassette Workflow x-given\",\n        \"spec\": {\n            \"triggers\": [\n                {\n                    \"startStepNames\": [\"No_op\"],\n                    \"workflowTrigger\": {}\n                }\n            ],\n            \"steps\": [\n              {\n                \"name\": \"No_op\",\n                \"actionId\": \"com.datadoghq.core.noop\"\n              }\n            ]\n        }\n    }\n  }\n}"
          step: there is a valid "workflow" in the system
      x-menu-order: 2
      x-permission:
        operator: OR
        permissions:
        - workflows_write
      x-undo:
        operationId: DeleteWorkflow
        parameters:
        - name: workflow_id
          source: data.id
        type: unsafe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/workflows/{workflow_id}:
    delete:
      description: Delete a workflow by ID. This API requires an application key scoped with the `workflows_write` permission.
      operationId: DeleteWorkflow
      parameters:
      - $ref: '#/components/parameters/WorkflowId'
      responses:
        '204':
          description: Successfully deleted a workflow.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Not found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Too many requests
      summary: Datadog Delete an Existing Workflow
      tags:
      - Workflows
      x-menu-order: 4
      x-permission:
        operator: OR
        permissions:
        - workflows_write
      x-undo:
        type: idempotent
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: Get a workflow by ID.  This API requires an application key scoped with the `workflows_read` permission.
      operationId: GetWorkflow
      parameters:
      - $ref: '#/components/parameters/WorkflowId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkflowResponse'
          description: Successfully got a workflow.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Not found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Too many requests
      summary: Datadog Get an Existing Workflow
      tags:
      - Workflows
      x-menu-order: 1
      x-permission:
        operator: OR
        permissions:
        - workflows_read
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      description: Update a workflow by ID. This API requires an application key scoped with the `workflows_write` permission.
      operationId: UpdateWorkflow
      parameters:
      - $ref: '#/components/parameters/WorkflowId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkflowResponse'
          description: Successfully updated a workflow.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Not found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JSONAPIErrorResponse'
          description: Too many requests
      summary: Datadog Update an Existing Workflow
      tags:
      - Workflows
      x-menu-order: 3
      x-permission:
        operator: OR
        permissions:
        - workflows_write
      x-undo:
        type: idempotent
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/workflows/{workflow_id}/instances:
    get:
      description: List all instances of a given workflow. This API requires an application key scoped with the workflows_read permission.
      operationId: ListWorkflowInstances
      parameters:
      - $ref: '#/components/parameters/WorkflowId'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PageNumber'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListInstancesResponse'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      security:
      - apiKeyAuth: []
        appKeyAuth: []
      - AuthZ:
        - workflows_read
      summary: Datadog List Workflow Instances
      tags:
      - Workflows
      x-menu-order: 5
      x-permission:
        operator: OR
        permissions:
        - workflows_read
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      description: Execute the given workflow. This API requires an application key scoped with the workflows_run permission.
      operationId: CreateWorkflowInstance
      parameters:
      - $ref: '#/components/parameters/WorkflowId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowInstanceCreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowInstanceCreateResponse'
          description: Created
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      security:
      - apiKeyAuth: []
        appKeyAuth: []
      - AuthZ:
        - workflows_run
      summary: Datadog Execute a Workflow
      tags:
      - Workflows
      x-codegen-request-body-name: body
      x-menu-order: 6
      x-permission:
        operator: OR
        permissions:
        - workflows_run
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/workflows/{workflow_id}/instances/{instance_id}:
    get:
      description: Get a specific execution of a given workflow. This API requires an application key scoped with the workflows_read permission.
      operationId: GetWorkflowInstance
      parameters:
      - $ref: '#/components/parameters/WorkflowId'
      - $ref: '#/components/parameters/InstanceId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorklflowGetInstanceResponse'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      security:
      - apiKeyAuth: []
        appKeyAuth: []
      - AuthZ:
        - workflows_read
      summary: Datadog Get a Workflow Instance
      tags:
      - Workflows
      x-menu-order: 7
      x-permission:
        operator: OR
        permissions:
        - workflows_read
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
    put:
      description: Cancels a specific execution of a given workflow. This API requires an application key scoped with the workflows_run permission.
      operationId: CancelWorkflowInstance
      parameters:
      - $ref: '#/components/parameters/WorkflowId'
      - $ref: '#/components/parameters/InstanceId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorklflowCancelInstanceResponse'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
      summary: Datadog Cancel a Workflow Instance
      tags:
      - Workflows
      x-menu-order: 8
      x-permission:
        operator: OR
        permissions:
        - workflows_run
      x-undo:
        type: safe
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Annotation:
      description: A list of annotations used in the workflow. These are like sticky notes for your workflow!
      properties:
        display:
          $ref: '#/components/schemas/AnnotationDisplay'
        id:
          description: The `Annotation` `id`.
          example: ''
          type: string
        markdownTextAnnotation:
          $ref: '#/components/schemas/AnnotationMarkdownTextAnnotation'
      required:
      - id
      - display
      - markdownTextAnnotation
      type: object
    SoftwareCatalogTriggerWrapper:
      description: Schema for a Software Catalog-based trigger.
      properties:
        softwareCatalogTrigger:
          description: Trigger a workflow from Software Catalog.
          type: object
        startStepNames:
          $ref: '#/components/schemas/StartStepNames'
      required:
      - softwareCatalogTrigger
      type: object
    MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest:
      description: Update Workflows webhook handle request.
      properties:
        data:
          $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData'
      required:
      - data
      type: object
    WorkflowDataUpdate:
      description: Data related to the workflow being updated.
      properties:
        attributes:
          $ref: '#/components/schemas/WorkflowDataUpdateAttributes'
        id:
          description: The workflow identifier
          type: string
          example: abc-123-def
        relationships:
          $ref: '#/components/schemas/WorkflowDataRelationships'
        type:
          $ref: '#/components/schemas/WorkflowDataType'
      required:
      - type
      - attributes
      type: object
    APITrigger:
      description: Trigger a workflow from an API request. The workflow must be published.
      properties:
        rateLimit:
          $ref: '#/components/schemas/TriggerRateLimit'
      type: object
    StartStepNames:
      description: A list of steps that run first after a trigger fires.
      example:
      - ''
      items:
        description: The `StartStepNames` `items`.
        type: string
      type: array
    UpdateWorkflowRequest:
      description: A request object for updating an existing workflow.
      example:
        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: 11111111-1111-1111-1111-111111111111
                  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
            - foo:bar
          id: 22222222-2222-2222-2222-222222222222
          type: workflows
      properties:
        data:
          $ref: '#/components/schemas/WorkflowDataUpdate'
      required:
      - data
      type: object
    JSONAPIErrorItem:
      description: API error response body
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the error.
          example: Missing required attribute in body
          type: string
        meta:
          additionalProperties: {}
          description: Non-standard meta-information about the error
          type: object
        source:
          $ref: '#/components/schemas/JSONAPIErrorItemSource'
        status:
          description: Status code of the response.
          example: '400'
          type: string
        title:
          description: Short human-readable summary of the error.
          example: Bad Request
          type: string
      type: object
    OutputSchemaParametersType:
      description: The definition of `OutputSchemaParametersType` object.
      enum:
      - STRING
      - NUMBER
      - BOOLEAN
      - OBJECT
      - ARRAY_STRING
      - ARRAY_NUMBER
      - ARRAY_BOOLEAN
      - ARRAY_OBJECT
      example: STRING
      type: string
      x-enum-varnames:
      - STRING
      - NUMBER
      - BOOLEAN
      - OBJECT
      - ARRAY_STRING
      - ARRAY_NUMBER
      - ARRAY_BOOLEAN
      - ARRAY_OBJECT
    GithubWebhookTrigger:
      description: 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.
      properties:
        rateLimit:
          $ref: '#/components/schemas/TriggerRateLimit'
      type: object
    WorklflowGetInstanceResponse:
      additionalProperties: {}
      description: The state of the given workflow instance.
      properties:
        data:
          $ref: '#/components/schemas/WorklflowGetInstanceResponseData'
      type: object
    CreateWorkflowResponse:
      description: The response object after creating a new workflow.
      properties:
        data:
          $ref: '#/components/schemas/WorkflowData'
      required:
      - data
      type: object
    MicrosoftTeamsWorkflowsWebhookHandlesResponse:
      description: Response with a list of Workflows webhook handles.
      properties:
        data:
          description: An array of Workflows webhook handles.
          example:
          - attributes:
              name: general-handle
            id: 596da4af-0563-4097-90ff-07230c3f9db3
            type: workflows-webhook-handle
          - attributes:
              name: general-handle-2
            id: 596da4af-0563-4097-90ff-07230c3f9db4
            type: workflows-webhook-handle
          items:
            $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData'
          type: array
      required:
      - data
      type: object
    StepDisplayBounds:
      description: The definition of `StepDisplayBounds` object.
      properties:
        x:
          description: The `bounds` `x`.
          format: double
          type: number
          example: 95.5
        y:
          description: The `bounds` `y`.
          format: double
          type: number
          example: 95.5
      type: object
    MicrosoftTeamsWorkflowsWebhookHandleAttributes:
      description: Workflows Webhook handle attributes.
      properties:
        name:
          description: Workflows Webhook handle name.
          example: fake-handle-name
          maxLength: 255
          type: string
        url:
          description: Workflows Webhook URL.
          example: https://fake.url.com
          maxLength: 255
          type: string
      type: object
    JSONAPIErrorResponse:
      description: API error response.
      properties:
        errors:
          description: A list of errors.
          items:
            $ref: '#/components/schemas/JSONAPIErrorItem'
          type: array
      required:
      - errors
      type: object
    InputSchema:
      description: A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
      properties:
        parameters:
          description: The `InputSchema` `parameters`.
          items:
            $ref: '#/components/schemas/InputSchemaParameters'
          type: array
      type: object
    CaseTrigger:
      description: Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
      properties:
        rateLimit:
          $ref: '#/components/schemas/TriggerRateLimit'
      type: object
    AppTriggerWrapper:
      description: Schema for an App-based trigger.
      properties:
        appTrigger:
          description: Trigger a workflow from an App.
          type: object
        startStepNames:
          $ref: '#/components/schemas/StartStepNames'
      required:
      - appTrigger
      type: object
    WorklflowCancelInstanceResponse:
      description: Information about the canceled instance.
      properties:
        data:
          $ref: '#/components/schemas/WorklflowCancelInstanceResponseData'
      type: object
    WorkflowTriggerWrapper:
      description: Schema for a Workflow-based trigger.
      properties:
        startStepNames:
          $ref: '#/components/schemas/StartStepNames'
        workflowTrigger:
          description: Trigger a workflow from the Datadog UI. Only required if no other trigger exists.
          type: object
      required:
      - workflowTrigger
      type: object
    GithubWebhookTriggerWrapper:
      description: Schema for a GitHub webhook-based trigger.
      properties:
        githubWebhookTrigger:
          $ref: '#/components/schemas/GithubWebhookTrigger'
        startStepNames:
          $ref: '#/components/schemas/StartStepNames'
      required:
      - githubWebhookTrigger
      type: object
    Trigger:
      description: One of the triggers that can start the execution of a workflow.
      oneOf:
      - $ref: '#/components/schemas/APITriggerWrapper'
      - $ref: '#/components/schemas/AppTriggerWrapper'
      - $ref: '#/components/schemas/CaseTriggerWrapper'
      - $ref: '#/components/schemas/ChangeEventTriggerWrapper'
      - $ref: '#/components/schemas/DatabaseMonitoringTriggerWrapper'
      - $ref: '#/components/schemas/DashboardTriggerWrapper'
      - $ref: '#/components/schemas/GithubWebhookTriggerWrapper'
      - $ref: '#/components/schemas/IncidentTriggerWrapper'
      - $ref: '#/components/schemas/MonitorTriggerWrapper'
      - $ref: '#/components/schemas/NotebookTriggerWrapper'
      - $ref: '#/components/schemas/ScheduleTriggerWrapper'
      - $ref: '#/components/schemas/SecurityTriggerWrapper'
      - $ref: '#/components/schemas/SelfServiceTriggerWrapper'
      - $ref: '#/components/schemas/SlackTriggerWrapper'
      - $ref: '#/components/schemas/SoftwareCatalogTriggerWrapper'
      - $ref: '#/components/schemas/WorkflowTriggerWrapper'
    UpdateWorkflowResponse:
      description: The response object after updating a workflow.
      properties:
        data:
          $ref: '#/components/schemas/WorkflowDataUpdate'
      type: object
    StepDisplay:
      description: The definition of `StepDisplay` object.
      properties:
        bounds:
    

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/datadog/refs/heads/main/openapi/datadog-workflows-api-openapi.yml