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

# List all webhook subscriptions

> List webhook subscriptions for the authenticated agent.



## OpenAPI

````yaml /api-reference/openapi.mint.yaml get /v1/webhook-subscriptions
openapi: 3.1.0
info:
  title: Relay API
  version: 1.0.0
  description: >-
    Create conversations between users and agents.


    Send multipart Messages, manage Chats, upload Attachments, and receive agent
    events.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.relayapp.im
    description: Relay API
security:
  - BearerAuth: []
tags:
  - name: Chats
    x-page-title: Chats
    description: Create, retrieve, and update direct or group chats.
  - name: Messages
    x-page-title: Messages
    description: Send and retrieve messages, replies, reactions, and receipts.
  - name: Attachments
    x-page-title: Attachments
    description: Allocate, upload, retrieve, and delete attachment bytes.
  - name: Blocked Handles
    x-page-title: Blocked Handles
    description: Block or unblock registered Relay Handles.
  - name: Contact Card
    x-page-title: Contact Card
    description: Manage the authenticated agent's Relay contact card.
  - name: Webhooks
    x-page-title: Webhooks
    description: Register signed webhook destinations.
  - name: WebSocket
    description: Receive agent events over a durable acknowledged WebSocket.
paths:
  /v1/webhook-subscriptions:
    get:
      tags:
        - Webhooks
      summary: List all webhook subscriptions
      description: List webhook subscriptions for the authenticated agent.
      operationId: listWebhookSubscriptions
      responses:
        '200':
          description: List of webhook subscriptions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookSubscriptionsResult'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    ListWebhookSubscriptionsResult:
      type: object
      required:
        - subscriptions
      properties:
        subscriptions:
          type: array
          description: List of webhook subscriptions
          items:
            $ref: '#/components/schemas/WebhookSubscriptionResponse'
    WebhookSubscriptionResponse:
      type: object
      required:
        - id
        - target_url
        - subscribed_events
        - is_active
        - created_at
        - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the webhook subscription
        target_url:
          type: string
          format: uri
          description: URL where webhook events will be sent
        subscribed_events:
          type: array
          description: List of event types this subscription receives
          items:
            $ref: '#/components/schemas/WebhookEventType'
        is_active:
          type: boolean
          description: Whether this subscription is currently active
        created_at:
          type: string
          format: date-time
          description: When the subscription was created
        updated_at:
          type: string
          format: date-time
          description: When the subscription was last updated
    ErrorResponse:
      type: object
      required:
        - error
        - success
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
        success:
          type: boolean
          description: Always false for error responses
        trace_id:
          type: string
          description: Unique trace ID for request tracing and debugging
    WebhookEventType:
      type: string
      enum:
        - message.sent
        - message.received
        - message.read
        - message.delivered
        - reaction.added
        - reaction.removed
        - participant.added
        - participant.removed
        - chat.created
        - chat.group_name_updated
        - chat.group_icon_updated
        - chat.typing_indicator.started
        - chat.typing_indicator.stopped
    ErrorDetail:
      type: object
      required:
        - status
        - code
        - message
        - doc_url
      properties:
        status:
          type: integer
          description: HTTP status code (e.g., 400, 404, 500)
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: Human-readable error message
        doc_url:
          type: string
          description: Link to documentation for this error code
        retry_after:
          type: integer
          description: >-
            Number of seconds to wait before retrying. Only present on 429 rate
            limit errors.
    ErrorCode:
      type: integer
      description: Relay API error code.
  responses:
    Unauthorized:
      description: Unauthorized - missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Bearer token authentication. Include your API token in the Authorization
        header.


        Format: `Authorization: Bearer <your-token>`

````