openapi: 3.2.0
info:
  description: To get started using Cloudflare's products and services via the API, refer to how to interact with Cloudflare, which covers using tools like Terraform and the official SDKs to maintain your Cloudflare resources.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: Cloudflare Notification Webhooks API
  version: 4.0.0
tags:
- name: Notification Web Hooks
paths:
  /accounts/{account_id}/alerting/v3/destinations/webhooks:
    get:
      description: Gets a list of all configured webhook destinations.
      operationId: notification-webhooks-list-webhooks
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_webhooks_components-schemas-response_collection'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: List webhooks response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_webhooks_components-schemas-response_collection'
          description: List webhooks response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List webhooks
      tags:
      - Notification Web Hooks
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - Notifications Write
      - Notifications Read
      - Account Settings Write
      - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    post:
      description: Creates a new webhook destination.
      operationId: notification-webhooks-create-a-webhook
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/aaa_components-schemas-name'
                secret:
                  $ref: '#/components/schemas/aaa_secret'
                url:
                  $ref: '#/components/schemas/aaa_url'
              required:
              - name
              - url
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_id_response'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Create a webhook response failure
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Create a webhook response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a webhook
      tags:
      - Notification Web Hooks
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}:
    delete:
      description: Delete a configured webhook destination.
      operationId: notification-webhooks-delete-a-webhook
      parameters:
      - in: path
        name: webhook_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_webhook-id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_api-response-collection'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Delete a webhook response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_api-response-collection'
          description: Delete a webhook response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a webhook
      tags:
      - Notification Web Hooks
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    get:
      description: Get details for a single webhooks destination.
      operationId: notification-webhooks-get-a-webhook
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      - in: path
        name: webhook_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_webhook-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_schemas-single_response'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Get a webhook response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_schemas-single_response'
          description: Get a webhook response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a webhook
      tags:
      - Notification Web Hooks
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - Notifications Write
      - Notifications Read
      - Account Settings Write
      - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    put:
      description: Update a webhook destination.
      operationId: notification-webhooks-update-a-webhook
      parameters:
      - in: path
        name: webhook_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_webhook-id'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/aaa_components-schemas-name'
                secret:
                  $ref: '#/components/schemas/aaa_secret'
                url:
                  $ref: '#/components/schemas/aaa_url'
              required:
              - name
              - url
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_id_response'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Update a webhook response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Update a webhook response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a webhook
      tags:
      - Notification Web Hooks
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
components:
  schemas:
    aaa_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      readOnly: true
      type: string
      x-auditable: true
    aaa_created_at:
      description: Timestamp of when the webhook destination was created.
      example: '2020-10-26T18:25:04.532316Z'
      format: date-time
      readOnly: true
      type: string
    aaa_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    aaa_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/aaa_result_info'
      type: object
    aaa_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    aaa_webhooks_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/aaa_webhooks'
            type: array
    aaa_components-schemas-type:
      description: Type of webhook endpoint.
      enum:
      - slack
      - generic
      - gchat
      example: slack
      type: string
    aaa_account-id:
      description: The account id
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    aaa_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/aaa_messages'
        messages:
          $ref: '#/components/schemas/aaa_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    aaa_webhook-id:
      description: The unique identifier of a webhook
      example: b115d5ec-15c6-41ee-8b76-92c449b5227b
      maxLength: 36
      readOnly: true
      type: string
    aaa_last_success:
      description: Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.
      example: '2020-10-26T18:25:04.532316Z'
      format: date-time
      readOnly: true
      type: string
    aaa_schemas-api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/aaa_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/aaa_messages'
          example: []
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    aaa_components-schemas-name:
      description: The name of the webhook destination. This will be included in the request body when you receive a webhook notification.
      example: Slack Webhook
      type: string
    aaa_secret:
      description: Optional secret that will be passed in the `cf-webhook-auth` header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body.
      type: string
    aaa_id_response:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/aaa_uuid'
            type: object
    aaa_last_failure:
      description: Timestamp of the last time an attempt to dispatch a notification to this webhook failed.
      example: '2020-10-26T18:25:04.532316Z'
      format: date-time
      readOnly: true
      type: string
    aaa_webhooks:
      properties:
        created_at:
          $ref: '#/components/schemas/aaa_created_at'
        id:
          $ref: '#/components/schemas/aaa_webhook-id'
        last_failure:
          $ref: '#/components/schemas/aaa_last_failure'
        last_success:
          $ref: '#/components/schemas/aaa_last_success'
        name:
          $ref: '#/components/schemas/aaa_components-schemas-name'
        secret:
          $ref: '#/components/schemas/aaa_secret'
        type:
          $ref: '#/components/schemas/aaa_components-schemas-type'
        url:
          $ref: '#/components/schemas/aaa_url'
      type: object
    aaa_api-response-single:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-common'
      type: object
    aaa_url:
      description: The POST endpoint to call when dispatching a notification.
      example: https://hooks.slack.com/services/REDACTED
      type: string
    aaa_schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/aaa_webhooks'
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey