> ## 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.

# Create a webhook endpoint

> Registers an endpoint and returns its signing secret once (stored encrypted; delete and recreate to rotate). The URL must
be https on the default port, at most 2048 characters, with no embedded credentials, and resolve to a public host that
isn't ours. Max 10 endpoints (409). 503 when server-side encryption isn't configured. Writes a WEBHOOK_ENDPOINT_CREATED
audit entry.



## OpenAPI

````yaml /api-reference/openapi.yaml post /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:
    post:
      tags:
        - Webhooks
      summary: Create a webhook endpoint
      description: >-
        Registers an endpoint and returns its signing secret once (stored
        encrypted; delete and recreate to rotate). The URL must

        be https on the default port, at most 2048 characters, with no embedded
        credentials, and resolve to a public host that

        isn't ours. Max 10 endpoints (409). 503 when server-side encryption
        isn't configured. Writes a WEBHOOK_ENDPOINT_CREATED

        audit entry.
      operationId: publicUserCreateWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                description:
                  type:
                    - string
                    - 'null'
                  maxLength: 200
                  description: Trimmed; blank becomes null.
                events:
                  type:
                    - array
                    - 'null'
                  description: >-
                    Events to receive. Empty, null or omitted means every event,
                    including ones added later. Duplicates are collapsed.
                  items:
                    $ref: '#/components/schemas/PublicUserWebhookEvent'
      responses:
        '201':
          description: Endpoint created.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    allOf:
                      - $ref: '#/components/schemas/PublicUserWebhookEndpoint'
                      - type: object
                        required:
                          - secret
                        properties:
                          secret:
                            type: string
                            description: Signing secret. Shown once.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          description: Webhooks are unavailable (encryption key not configured).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    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
    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
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    BadRequest:
      description: Validation failed or the request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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'
    Conflict:
      description: The request conflicts with the resource's current state.
      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.