> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Webhooks

> Retrieves webhooks for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When more records exist than are returned, `meta.total` exceeds `data.length`; clients with large collections must page with `limit`/`offset` to retrieve them all.



## OpenAPI

````yaml https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json get /api/v2/webhooks
openapi: 3.0.0
info:
  title: HyperDX External API
  description: API for managing HyperDX alerts and dashboards
  version: 2.0.0
servers:
  - url: /
    description: Your HyperDX instance (http://<host>:<port>)
security:
  - BearerAuth: []
tags:
  - name: Dashboards
    description: Endpoints for managing dashboards and their visualizations
  - name: Alerts
    description: Endpoints for managing monitoring alerts
  - name: Charts
    description: Endpoints for querying chart data
  - name: Connections
    description: Endpoints for managing ClickHouse connections
  - name: Sources
    description: Endpoints for managing data sources
  - name: Webhooks
    description: Endpoints for managing webhooks
  - name: Search
    description: Endpoints for querying raw data from log and trace sources
paths:
  /api/v2/webhooks:
    get:
      tags:
        - Webhooks
      summary: List Webhooks
      description: >-
        Retrieves webhooks for the authenticated team (paginated). Results are
        capped at `limit` (default and maximum 1000). When more records exist
        than are returned, `meta.total` exceeds `data.length`; clients with
        large collections must page with `limit`/`offset` to retrieve them all.
      operationId: listWebhooks
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 1000
          description: Maximum number of webhooks to return.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Number of webhooks to skip before returning results.
      responses:
        '200':
          description: Successfully retrieved webhooks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhooksListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Unauthorized access. API key is missing or invalid.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    WebhooksListResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          description: List of webhook objects.
          items:
            $ref: '#/components/schemas/Webhook'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
          description: Pagination metadata for this result page.
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
          example: 'NOT_FOUND: Alert not found'
    Webhook:
      oneOf:
        - $ref: '#/components/schemas/SlackWebhook'
        - $ref: '#/components/schemas/IncidentIOWebhook'
        - $ref: '#/components/schemas/GenericWebhook'
      discriminator:
        propertyName: service
        mapping:
          slack:
            $ref: '#/components/schemas/SlackWebhook'
          incidentio:
            $ref: '#/components/schemas/IncidentIOWebhook'
          generic:
            $ref: '#/components/schemas/GenericWebhook'
    PaginationMeta:
      type: object
      required:
        - total
        - limit
        - offset
      properties:
        total:
          type: integer
          description: Total number of items matching the query, ignoring pagination.
          example: 142
        limit:
          type: integer
          description: Maximum number of items returned in this page.
          example: 50
        offset:
          type: integer
          description: Number of items skipped before this page.
          example: 100
    SlackWebhook:
      type: object
      required:
        - id
        - name
        - service
        - updatedAt
        - createdAt
      properties:
        id:
          type: string
          description: Webhook ID
          example: 507f1f77bcf86cd799439011
        name:
          type: string
          description: Webhook name
          example: Production Alerts
        service:
          type: string
          enum:
            - slack
          description: Webhook service type
          example: slack
        url:
          type: string
          description: Slack incoming webhook URL
          example: >-
            https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
        description:
          type: string
          description: Webhook description, shown in the UI
          example: 'Sends critical alerts to the #incidents channel'
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp
          example: '2025-06-15T10:30:00.000Z'
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2025-01-01T00:00:00.000Z'
    IncidentIOWebhook:
      type: object
      required:
        - id
        - name
        - service
        - updatedAt
        - createdAt
      properties:
        id:
          type: string
          description: Webhook ID
          example: 507f1f77bcf86cd799439012
        name:
          type: string
          description: Webhook name
          example: Incident Response
        service:
          type: string
          enum:
            - incidentio
          description: Webhook service type
          example: incidentio
        url:
          type: string
          description: incident.io alert event HTTP source URL
          example: https://api.incident.io/v2/alert_events/http/abc123
        description:
          type: string
          description: Webhook description, shown in the UI
          example: Routes alerts to incident.io for on-call escalation
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp
          example: '2025-06-15T10:30:00.000Z'
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2025-01-01T00:00:00.000Z'
    GenericWebhook:
      type: object
      required:
        - id
        - name
        - service
        - updatedAt
        - createdAt
      properties:
        id:
          type: string
          description: Webhook ID
          example: 507f1f77bcf86cd799439013
        name:
          type: string
          description: Webhook name
          example: PagerDuty Integration
        service:
          type: string
          enum:
            - generic
          description: Webhook service type
          example: generic
        url:
          type: string
          description: Webhook destination URL
          example: https://example.com/webhooks/alerts
        description:
          type: string
          description: Webhook description, shown in the UI
          example: Forwards alert payloads to an external monitoring service
        body:
          type: string
          description: Optional request body template
          example: '{"alert": "{{title}}", "severity": "{{level}}"}'
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp
          example: '2025-06-15T10:30:00.000Z'
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
          example: '2025-01-01T00:00:00.000Z'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````