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

# Get webhooks

> List all webhooks known to the system.



## OpenAPI

````yaml /products/guardian/openapi.yaml get /api/admin/webhooks
openapi: 3.1.0
info:
  title: Guardian API
  version: '1.0'
  contact:
    name: Starfish GmbH & Co. KG
    email: hello@starfish.team
    url: https://hellgate.io/cpa/guardian
  license:
    name: Hellgate API Terms
    url: https://hellgate.io/terms-and-conditions
servers:
  - url: https://{cluster_id}.on-hellgate.cloud
    description: Guardian service instance
    variables:
      cluster_id:
        default: my-cluster-id
        description: |
          Guardian is a service of the Hellgate Cloud Platform.
          The unique cluster-id is used to connect to your instance.
security: []
tags:
  - name: pci
    description: Management of card payment credentials under the ruling of PCI DSS.
  - name: network
    description: Management of network tokens and cryptograms for secure transactions.
  - name: generic
    description: Management of generic tokens and their schemas for various use cases.
  - name: metadata
    description: Inquiries for card metadata based on PAN, PCI tokens, or network tokens.
  - name: apikey
    description: Management of API keys for service access.
  - name: webhook
    description: Management of webhooks for event notifications.
  - name: types
    description: Management of types for generic token schemas.
paths:
  /api/admin/webhooks:
    get:
      tags:
        - webhook
      summary: Get webhooks
      description: List all webhooks known to the system.
      operationId: admin_webhook_list
      parameters:
        - name: limit
          in: query
          description: >
            The limit parameter defines the maximum number of rows returned in a
            single call and enables consecutive pagination using the `next` link
            provided in the response payload.
          required: false
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook_list'
        '401':
          $ref: '#/components/responses/401_UnauthorizedError'
        '403':
          $ref: '#/components/responses/403_ForbiddenError'
      security:
        - APIKey: []
        - AdminToken: []
components:
  schemas:
    webhook_list:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/webhook'
        links:
          type: object
          properties:
            next:
              type: string
              format: uri
          required:
            - next
      required:
        - data
        - links
      example:
        data:
          - id: 123e4567-e89b-12d3-a456-426614174000
            created_at: '2023-10-01T12:00:00Z'
            masked_hmac_key: 123xxxx
            events:
              - network.token.updated
            url: https://example.com/webhook
        links:
          next: >-
            https://my-cluster-id.on-hellgate.cloud/admin/webhooks?after=123e4567-e89b-12d3-a456-426614174000&limit=20
    webhook:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier for the webhook.
        created_at:
          type: string
          format: date-time
          description: The timestamp when the webhook was created.
        events:
          type: array
          items:
            $ref: '#/components/schemas/event_type'
          minItems: 1
          description: The list of events the webhook is subscribed to.
        masked_hmac_key:
          type: string
          example: 123xxxx
          description: >-
            The masked HMAC key used to sign the payloads sent to the webhook
            URL.
        url:
          type: string
          format: uri
          description: The URL to which the webhook sends event notifications.
      required:
        - id
        - created_at
        - url
        - events
    ErrorGeneric:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ErrorStatusCode'
        classifier:
          $ref: '#/components/schemas/ErrorClassifier'
        message:
          $ref: '#/components/schemas/ErrorMessage'
    event_type:
      type: string
      enum:
        - network.token.updated
        - pci.token.security-code.expired
      description: The type of event that occurred.
    ErrorStatusCode:
      type: integer
      description: The corresponding HTTP status code for the error
    ErrorClassifier:
      type: string
      description: Technical code that helps to identify the error
    ErrorMessage:
      type: string
      description: Human readable representation of the error
  responses:
    401_UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
          example:
            code: 401
            message: No valid means of authentication was provided
            classifier: UNAUTHORIZED
    403_ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorGeneric'
          example:
            code: 403
            message: Not allowed to access this resource or feature
            classifier: FORBIDDEN
  securitySchemes:
    APIKey:
      type: apiKey
      name: x-api-key
      in: header
    AdminToken:
      type: apiKey
      name: x-admin-token
      in: header

````