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

# List webhooks

> Retrieves all webhook subscriptions for your brand.



## OpenAPI

````yaml /api-reference/openapi.json get /webhooks
openapi: 3.1.0
info:
  title: Sotto API
  version: 1.0.0
  description: >-
    The Sotto API provides programmatic access to manage users, send messages,
    upload files, configure webhooks, and read your segments and custom data
    fields. All requests are authenticated with an HMAC-SHA256 signature. See
    the **Authentication** guide for signing details.
  contact:
    name: Sotto Support
    email: support@bigco.ai
servers:
  - url: https://api.bigco.ai/api/v1
    description: Production
security:
  - hmacSignature: []
tags:
  - name: Users
    description: Create, retrieve, update, and delete users.
  - name: Messages
    description: Send messages to a user.
  - name: Files
    description: Upload media files for use in messages.
  - name: Brand
    description: Retrieve information about your brand.
  - name: Webhooks
    description: Subscribe to and manage event callbacks.
  - name: Segments
    description: Read the audience segments configured for your brand.
  - name: Custom Data
    description: Read the custom data fields configured for your brand.
paths:
  /webhooks:
    get:
      tags:
        - Webhooks
      summary: List webhooks
      description: Retrieves all webhook subscriptions for your brand.
      operationId: getWebhooks
      responses:
        '200':
          description: All webhook subscriptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhooksResponseAPI'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    WebhooksResponseAPI:
      type: object
      properties:
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/WebhookAPI'
      required:
        - webhooks
    WebhookAPI:
      type: object
      properties:
        topic:
          $ref: '#/components/schemas/WebhookTopic'
        address:
          type: string
          example: https://example.com/webhooks/callback
        id:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        date_created:
          type: string
          format: date-time
          example: '2024-01-01T12:00:00Z'
        date_last_updated:
          type: string
          format: date-time
          example: '2024-01-01T12:00:00Z'
        version:
          type: string
          description: The webhook API version.
          default: v1
          example: v1
      required:
        - topic
        - address
        - id
        - date_created
        - date_last_updated
        - version
    Error:
      type: object
      properties:
        detail:
          type: object
          properties:
            type:
              type: string
              description: Machine-readable error type.
              example: not_authenticated
            msg:
              type: string
              description: Human-readable error message.
              example: HMAC signature verification failed
          required:
            - type
            - msg
      required:
        - detail
    WebhookTopic:
      type: string
      description: The event topic a webhook subscribes to.
      enum:
        - user/opt-in
        - user/opt-out
        - user/update
        - ticket/updated
      example: user/opt-in
  responses:
    Unauthorized:
      description: Unauthorized — HMAC signature verification failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail:
              type: not_authenticated
              msg: HMAC signature verification failed
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail:
              type: UNCAUGHT_ERROR
              msg: Internal server error
  securitySchemes:
    hmacSignature:
      type: apiKey
      in: header
      name: x-bigco-hmac-sha256
      description: >-
        Base64-encoded HMAC-SHA256 signature of the request. Every request must
        also include the `x-bigco-hmac-username` and `x-date` headers, and
        POST/PUT requests must include `x-digest`. See the Authentication guide
        for the full signing procedure.

````