> ## Documentation Index
> Fetch the complete documentation index at: https://newscatcherinc-docs.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List webhooks

> Returns a paginated list of webhooks belonging to the organization.



## OpenAPI

````yaml catch-all-api get /catchAll/webhooks
openapi: 3.1.0
info:
  title: NewsCatcher CatchAll API
  version: 1.6.4
  description: >
    CatchAll is a web search API that generates unique datasets that don't exist
    anywhere else on the web. Built on NewsCatcher's proprietary real-world
    event index, it delivers state-of-the-art recall—finding all relevant
    events, not just top results.


    ### Authentication


    All endpoints except /health and /version require `x-api-key` header. If the
    key is invalid or missing, the API returns the `403 Forbidden` error.


    ### Job workflow


    1. (Optional) Get suggestions via /catchAll/initialize

    2. Submit a query via /catchAll/submit with optional date ranges and custom
    validators/enrichments

    3. Poll /catchAll/status/{job_id} until completed (10-15 minutes)

    4. Retrieve results via /catchAll/pull/{job_id}


    ### Monitor workflow


    1. Create successful job via /catchAll/submit

    2. Create monitor via /catchAll/monitors/create with schedule

    3. Retrieve aggregated results via /catchAll/monitors/pull/{monitor_id}


    ### Webhook workflow


    1. Create a webhook via `POST /catchAll/webhooks`

    2. Attach it to a job or monitor via `POST
    /catchAll/webhooks/{webhook_id}/resources`,
       or pass `webhook_ids` at job or monitor creation time
    3. Receive HTTP notifications at the configured URL when each job completes


    ### Company search workflow


    1. Create a dataset via `POST /catchAll/datasets/` or `POST
    /catchAll/datasets/upload`

    2. Wait for the dataset `latest_status` to reach `ready`

    3. Submit a job with `connected_dataset_ids` pointing to your dataset

    4. Retrieve results — each record includes a `connected_entities` array
       with relevance scores per matched company

    ### Important notes


    **Dynamic schemas**: Response schemas are generated dynamically by LLMs.
    Field names in the `enrichment` object may vary and are not deterministic
    across jobs unless explicitly specified.
  contact:
    name: NewsCatcher
    url: https://newscatcherapi.com
    email: support@newscatcherapi.com
servers:
  - url: https://catchall.newscatcherapi.com
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Jobs
    description: Operations to create, monitor, and retrieve job results.
    externalDocs:
      description: Learn about job lifecycle and status tracking
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/get-started/quickstart
  - name: Monitors
    description: Operations to create, operate and retrieve monitor results.
    externalDocs:
      description: >-
        Automate recurring queries with scheduled jobs and webhook
        notifications.
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/monitors
  - name: Webhooks
    description: >
      Operations to create and manage reusable webhook endpoints.


      A webhook is a named HTTP endpoint that receives a POST notification

      when a job or monitor completes. Create webhooks once at the organization

      level and attach them to any number of jobs or monitors via `webhook_ids`.

      Supports Slack, Microsoft Teams, and generic HTTP targets with
      configurable

      delivery modes, authentication, and headers.
    externalDocs:
      description: Learn about centralized webhooks and notification setup
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/webhooks
  - name: Entities
    description: >
      Operations to create, update, and delete company entities.


      Entities are the building blocks of Company Watchlist. Each entity
      represents

      a company (or person) you want to track. Add identifying information such
      as

      domain, alternative names, and key persons to improve matching quality.
    externalDocs:
      description: Learn about Company Watchlist and entities
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/company-search
  - name: Datasets
    description: >
      Operations to create and manage datasets of entities.


      A dataset is a named collection of entities — think of it as a watchlist
      or

      portfolio. Connect a dataset to a job via `connected_dataset_ids` to
      activate

      Company Watchlist. Datasets can be reused across multiple jobs and
      monitors.
    externalDocs:
      description: Learn about datasets and Company Watchlist
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/company-search
  - name: Projects
    description: |
      Operations to create, organize, and manage projects.

      A project is a named container for jobs, monitors, and datasets. Group
      related resources by use case, team, or client, and share them with
      teammates. Resources can be assigned at creation time or post-hoc.
    externalDocs:
      description: Learn about projects and resource organization
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/projects
  - name: Meta
    description: Operations to check API health and version.
externalDocs:
  description: Find out more about NewsCatcher CatchAll API
  url: https://www.newscatcherapi.com/docs/web-search-api/get-started/introduction
paths:
  /catchAll/webhooks:
    get:
      tags:
        - Webhooks
      summary: List webhooks
      description: Returns a paginated list of webhooks belonging to the organization.
      operationId: listWebhooks
      parameters:
        - $ref: '#/components/parameters/Page'
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Number of webhooks per page.
        - $ref: '#/components/parameters/Search'
      responses:
        '200':
          $ref: '#/components/responses/ListWebhooksResponse'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    Page:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
      description: |
        Page number to retrieve.
    Search:
      name: search
      in: query
      required: false
      schema:
        type: string
      description: Filter results by text (case-insensitive substring match).
  responses:
    ListWebhooksResponse:
      description: Webhooks retrieved successfully.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListWebhooksResponseDto'
          example:
            total: 2
            page: 1
            page_size: 100
            total_pages: 1
            webhooks:
              - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                name: Layoffs Alert
                url: https://hooks.slack.com/services/T000/B000/xxx
                type: slack
                delivery_mode: full
                method: POST
                headers: {}
                params: {}
                formatter_config: null
                is_active: true
                organization_id: org-uuid-here
                created_by_user_id: user-uuid-here
                created_at: '2026-05-18T10:00:00Z'
                updated_at: '2026-05-18T10:00:00Z'
              - id: b2c3d4e5-f6a7-8901-bcde-f12345678901
                name: M&A Tracker
                url: https://my-service.example.com/catchall-hook
                type: generic
                delivery_mode: per_record
                method: POST
                headers:
                  Authorization: Bearer token123
                params: {}
                formatter_config: null
                is_active: true
                organization_id: org-uuid-here
                created_by_user_id: user-uuid-here
                created_at: '2026-05-19T09:00:00Z'
                updated_at: '2026-05-19T09:00:00Z'
    ForbiddenError:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  schemas:
    ListWebhooksResponseDto:
      type: object
      required:
        - total
        - page
        - page_size
        - total_pages
        - webhooks
      properties:
        total:
          type: integer
          description: Total number of webhooks in the organization.
          example: 3
        page:
          type: integer
          description: Current page number.
          example: 1
        page_size:
          type: integer
          description: Number of webhooks per page.
          example: 100
        total_pages:
          type: integer
          description: Total number of pages available.
          example: 1
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/WebhookResponseDto'
          description: Webhooks on this page.
    Error:
      type: object
      properties:
        detail:
          type: string
          description: Error message.
          example: Invalid API key
    ValidationErrorResponse:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorDetail'
    WebhookResponseDto:
      type: object
      required:
        - id
        - name
        - url
        - type
        - delivery_mode
        - method
        - is_active
      properties:
        id:
          type: string
          format: uuid
          description: Webhook identifier.
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        name:
          type: string
          description: Human-readable label for this webhook.
          example: Layoffs Alert
        url:
          type: string
          format: uri
          description: Destination URL that receives the payload.
          example: https://hooks.slack.com/services/T000/B000/xxx
        type:
          $ref: '#/components/schemas/WebhookType'
        delivery_mode:
          $ref: '#/components/schemas/DeliveryMode'
        method:
          $ref: '#/components/schemas/HttpMethod'
        headers:
          type: object
          additionalProperties:
            type: string
          description: Custom HTTP headers forwarded with each delivery.
          example:
            Authorization: Bearer token123
        params:
          type: object
          additionalProperties:
            type: string
          description: Query parameters appended to the webhook URL.
          example: {}
        formatter_config:
          anyOf:
            - $ref: '#/components/schemas/FormatterConfigDto'
            - type: 'null'
          description: Custom payload formatter. Set only when `type` is `custom`.
          example: null
        is_active:
          type: boolean
          description: True if the webhook is active; false otherwise.
          example: true
        organization_id:
          type: string
          description: Organization that owns this webhook.
          example: org-uuid-here
        created_by_user_id:
          type: string
          description: ID of the user who created this webhook.
          example: user-uuid-here
        created_at:
          type: string
          format: date-time
          description: Webhook creation timestamp in ISO 8601 format with UTC timezone.
          example: '2026-05-18T10:00:00Z'
        updated_at:
          type: string
          format: date-time
          description: Timestamp of the last update in ISO 8601 format with UTC timezone.
          example: '2026-05-18T10:00:00Z'
    ValidationErrorDetail:
      type: object
      properties:
        loc:
          type: array
          items:
            oneOf:
              - type: string
              - type: integer
          description: Location of the validation error
        msg:
          type: string
          description: Error message
        type:
          type: string
          description: Error type
    WebhookType:
      type: string
      enum:
        - generic
        - slack
        - teams
        - custom
      description: >
        Webhook target type.


        - `generic`: Sends the raw result payload to any HTTPS endpoint.

        - `slack`: Sends a formatted Slack Block Kit message. URL must start
        with `https://hooks.slack.com/`.

        - `teams`: Sends a formatted Microsoft Teams Adaptive Card. URL hostname
        must match `*webhook.office.com` or `*.webhook.office365.com`.

        - `custom`: Sends a transformed payload using the configuration in
        `formatter_config`. Requires `formatter_config` to be set.


        When `type` is omitted, it is auto-detected from the URL.
    DeliveryMode:
      type: string
      enum:
        - full
        - per_record
      description: >
        Delivery mode for webhook payloads.


        - `full`: Sends all records in a single request on each trigger.

        - `per_record`: Sends one request per record. For large result sets,
        this may generate many requests.
    HttpMethod:
      type: string
      enum:
        - GET
        - POST
        - PUT
        - PATCH
        - DELETE
      description: HTTP method used for webhook delivery.
    FormatterConfigDto:
      type: object
      required:
        - template
      description: >
        Custom payload formatter for `custom` webhooks. A Liquid template is

        rendered at dispatch time to build a fully tailored request body — trim
        or

        rename fields, apply conditional logic, or emit non-JSON formats.
      properties:
        template:
          type: string
          description: |
            Liquid template string rendered at dispatch time. Maximum 10 KB.
          example: '{"event": "{{ event }}", "count": {{ records_count }}}'
        content_type:
          type: string
          default: application/json
          description: >
            Content-Type of the rendered output. Supported values:
            `application/json`,

            `application/ld+json`, `text/html`, `text/plain`, `text/xml`,

            `application/xml`, `text/csv`.
          example: application/json
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication.

````