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

# List Webhooks



## OpenAPI

````yaml /openapi/tms.json get /webhooks
openapi: 3.0.3
info:
  title: Universal TMS API Documentation
  description: Development documentation
  version: '1.0'
servers:
  - url: https://tms.universal.rollout.com/api
security: []
paths:
  /webhooks:
    get:
      tags:
        - Webhooks
      summary: List Webhooks
      operationId: getWebhooks
      parameters:
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - id
              - created
              - updated
              - status
              - event
        - name: event
          in: query
          required: false
          schema:
            type: string
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - Active
              - Disabled
        - name: next
          in: query
          required: false
          schema:
            type: string
            description: >-
              Cursor of the page to return, from the previous page's
              `_metadata.next`. Can't be combined with `offset`.
        - name: offset
          in: query
          required: false
          schema:
            type: number
            description: >-
              Number of records to skip, for offset paging. Defaults to 0. Can't
              be combined with `next`.
        - name: limit
          in: query
          required: false
          schema:
            default: 10
            description: Records per page, capped at 100.
            type: number
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    type: object
                    properties:
                      collection:
                        type: string
                        enum:
                          - webhooks
                        description: The key of this response that holds the records.
                      offset:
                        type: number
                        description: >-
                          Number of records skipped before this page: the
                          `offset` requested, or 0 on a cursor page.
                      limit:
                        type: number
                        description: >-
                          Page size applied: the `limit` requested, capped at
                          100, or 10 by default.
                      total:
                        type: number
                        description: >-
                          Number of records matching the request, across all
                          pages.
                      next:
                        nullable: true
                        description: >-
                          Cursor of the next page, to pass as `next`; null on
                          the last page.
                        type: string
                      nextLink:
                        nullable: true
                        description: >-
                          URL of the next page, this request's with `next` set;
                          null on the last page.
                        type: string
                    required:
                      - collection
                      - offset
                      - limit
                      - total
                      - next
                      - nextLink
                    description: How this page relates to the whole collection.
                  webhooks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        status:
                          type: string
                          enum:
                            - Active
                            - Disabled
                        event:
                          type: string
                        url:
                          type: string
                        filters:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              equals:
                                type: string
                            required:
                              - equals
                      required:
                        - id
                        - status
                        - event
                        - url
                        - filters
                    description: The records of this page, under the collection's name.
                required:
                  - _metadata
                  - webhooks
        '400':
          description: Response for status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorMessage:
                    type: string
                required:
                  - errorMessage
      security:
        - jwt: []
          credential_id: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      description: Consumer JWT minted by the tenant's backend
    credential_id:
      type: apiKey
      in: header
      name: X-Rollout-Credential-Id
      description: The Rollout Credential ID to use for queries/mutations

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.