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 Webhooks 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: Webhooks
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:
      - Webhooks
      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:
      - Webhooks
      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:
      - Webhooks
      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:
      - Webhooks
      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:
      - Webhooks
      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
components:
  schemas:
    MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest:
      description: Update Workflows webhook handle request.
      properties:
        data:
          $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData'
      required:
      - data
      type: object
    MicrosoftTeamsWorkflowsWebhookHandleResponseData:
      description: Workflows Webhook handle data from a response.
      properties:
        attributes:
          $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookResponseAttributes'
        id:
          description: The ID of the Workflows webhook handle.
          example: 596da4af-0563-4097-90ff-07230c3f9db3
          maxLength: 100
          minLength: 1
          type: string
        type:
          $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType'
      type: object
    MicrosoftTeamsCreateWorkflowsWebhookHandleRequest:
      description: Create Workflows webhook handle request.
      properties:
        data:
          $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestData'
      required:
      - data
      type: object
    APIErrorResponse:
      description: API error response.
      properties:
        errors:
          description: A list of errors.
          example:
          - Bad Request
          items:
            description: A list of items.
            example: Bad Request
            type: string
          type: array
      required:
      - errors
      type: object
    MicrosoftTeamsWorkflowsWebhookHandleResponse:
      description: Response of a Workflows webhook handle.
      properties:
        data:
          $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData'
      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
    MicrosoftTeamsWorkflowsWebhookHandleRequestData:
      description: Workflows Webhook handle data from a response.
      properties:
        attributes:
          $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes'
        type:
          $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType'
      required:
      - type
      - attributes
      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
    MicrosoftTeamsWorkflowsWebhookHandleType:
      default: workflows-webhook-handle
      description: Specifies the Workflows webhook handle resource type.
      enum:
      - workflows-webhook-handle
      example: workflows-webhook-handle
      type: string
      x-enum-varnames:
      - WORKFLOWS_WEBHOOK_HANDLE
    MicrosoftTeamsWorkflowsWebhookResponseAttributes:
      description: Workflows Webhook handle attributes.
      properties:
        name:
          description: Workflows Webhook handle name.
          example: fake-handle-name
          maxLength: 255
          type: string
      type: object
    MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData:
      description: Workflows Webhook handle data from a response.
      properties:
        attributes:
          $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleAttributes'
        type:
          $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType'
      required:
      - type
      - attributes
      type: object
    MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes:
      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
      required:
      - name
      - url
      type: object
  parameters:
    MicrosoftTeamsWorkflowsWebhookHandleNameQueryParameter:
      description: Your Workflows webhook handle name.
      in: query
      name: name
      required: false
      schema:
        type: string
    MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter:
      description: Your Workflows webhook handle id.
      in: path
      name: handle_id
      required: true
      schema:
        type: string
  responses:
    TooManyRequestsResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Too many requests
    NotFoundResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Not Found
    PreconditionFailedResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Failed Precondition
    BadRequestResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Bad Request
    ForbiddenResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Forbidden
    ConflictResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/APIErrorResponse'
      description: Conflict
  securitySchemes:
    AuthZ:
      description: This API uses OAuth 2 with the implicit grant flow.
      flows:
        authorizationCode:
          authorizationUrl: /oauth2/v1/authorize
          scopes:
            apm_api_catalog_read: View API catalog and API definitions.
            apm_api_catalog_write: Add, modify, and delete API catalog definitions.
            apm_read: Read and query APM and Trace Analytics.
            apm_service_catalog_read: View service catalog and service definitions.
            apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.
            appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source.
            cases_read: View Cases.
            cases_write: Create and update cases.
            ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API.
            ci_visibility_read: View CI Visibility.
            cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs.
            cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs.
            code_analysis_read: View Code Analysis.
            continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).
            create_webhooks: Create webhooks integrations.
            dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'.
            dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'.
            dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally.
            dashboards_read: View dashboards.
            dashboards_write: Create and change dashboards.
            data_scanner_read: View Data Scanner configurations.
            data_scanner_write: Edit Data Scanner configurations.
            embeddable_graphs_share: Generate public links to share embeddable graphs externally.
            events_read: Read Events data.
            hosts_read: List hosts and their attributes.
            incident_notification_settings_write: Configure Incidents Notification settings.
            incident_read: View incidents in Datadog.
            incident_settings_write: Configure Incident Settings.
            incident_write: Create, view, and manage incidents in Datadog.
            metrics_read: View custom metrics.
            monitor_config_policy_write: Edit and delete monitor configuration.
            monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.
            monitors_read: View monitors.
            monitors_write: Edit, delete, and resolve individual monitors.
            org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.
            security_comments_read: Read comments of vulnerabilities.
            security_monitoring_filters_read: Read Security Filters.
            security_monitoring_filters_write: Create, edit, and delete Security Filters.
            security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks.
            security_monitoring_notification_profiles_read: View Rule Security Notification rules.
            security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules.
            security_monitoring_rules_read: Read Detection Rules.
            security_monitoring_rules_write: Create and edit Detection Rules.
            security_monitoring_signals_read: View Security Signals.
            security_monitoring_suppressions_read: Read Rule Suppressions.
            security_monitoring_suppressions_write: Write Rule Suppressions.
            security_pipelines_read: View Security Pipelines.
            security_pipelines_write: Create, edit, and delete CSM Security Pipelines.
            slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.
            slos_read: View SLOs and status corrections.
            slos_write: Create, edit, and delete SLOs.
            synthetics_global_variable_read: View, search, and use Synthetics global variables.
            synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics.
            synthetics_private_location_read: View, search, and use Synthetics private locations.
            synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines.
            synthetics_read: List and view configured Synthetic tests and test results.
            synthetics_write: Create, edit, and delete Synthetic tests.
            teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.
            teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.
            test_optimization_read: View Test Optimization.
            timeseries_query: Query Timeseries data.
            usage_read: View your organization's usage and usage attribution.
            user_access_invite: Invite other users to your organization.
            user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.
            user_access_read: View users and their roles and settings.
            workflows_read: View workflows.
            workflows_run: Run workflows.
            workflows_write: Create, edit, and delete workflows.
          tokenUrl: /oauth2/v1/token
      type: oauth2
    apiKeyAuth:
      description: Your Datadog API Key.
      in: header
      name: DD-API-KEY
      type: apiKey
      x-env-name: DD_API_KEY
    appKeyAuth:
      description: Your Datadog APP Key.
      in: header
      name: DD-APPLICATION-KEY
      type: apiKey
      x-env-name: DD_APP_KEY
    bearerAuth:
      scheme: bearer
      type: http
      x-env-name: DD_BEARER_TOKEN
x-group-parameters: true
x-merge-override:
  paths: false