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

# List webhook endpoints

> The caller's endpoints (newest first), the event catalogue, and how deliveries are signed. Secrets are never returned.
Session only — a token must not be able to redirect the account's event stream.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/user/webhooks
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/user/webhooks:
    get:
      tags:
        - Webhooks
      summary: List webhook endpoints
      description: >-
        The caller's endpoints (newest first), the event catalogue, and how
        deliveries are signed. Secrets are never returned.

        Session only — a token must not be able to redirect the account's event
        stream.
      operationId: publicUserListWebhooks
      responses:
        '200':
          description: Endpoints, events and signature details.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                      - endpoints
                      - events
                      - signature
                    properties:
                      endpoints:
                        type: array
                        items:
                          $ref: '#/components/schemas/PublicUserWebhookEndpoint'
                      events:
                        type: array
                        items:
                          type: object
                          required:
                            - key
                            - label
                            - description
                          properties:
                            key:
                              $ref: '#/components/schemas/PublicUserWebhookEvent'
                            label:
                              type: string
                            description:
                              type: string
                      signature:
                        type: object
                        required:
                          - header
                          - format
                          - algorithm
                        properties:
                          header:
                            type: string
                            const: X-SE-Signature
                          format:
                            type: string
                            examples:
                              - t=<unix seconds>,v1=<hex>
                          algorithm:
                            type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    PublicUserWebhookEndpoint:
      type: object
      required:
        - id
        - url
        - description
        - events
        - active
        - disabledAt
        - consecutiveFails
        - lastDeliveryAt
        - createdAt
      properties:
        id:
          type: string
        url:
          type: string
          format: uri
        description:
          type:
            - string
            - 'null'
        events:
          type: array
          description: Empty means every event.
          items:
            $ref: '#/components/schemas/PublicUserWebhookEvent'
        active:
          type: boolean
        disabledAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Set when switched off by you or automatically after 15 consecutive
            failures.
        consecutiveFails:
          type: integer
          minimum: 0
        lastDeliveryAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    PublicUserWebhookEvent:
      type: string
      enum:
        - invoice.paid
        - invoice.refunded
        - team.member_joined
        - team.member_removed
        - team.service_shared
        - service.provisioned
        - service.suspended
        - service.unsuspended
        - service.terminated
        - ticket.replied
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

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