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

# Register a webhook

> Registers a webhook for one event type. Exactly one active registration
is allowed per association and event type; registering a type that
already has one returns 409, so deactivate the existing one first. The
URL must be https (plain http is tolerated in the sandbox only).




## OpenAPI

````yaml /api-reference/openapi.yaml post /webhooks
openapi: 3.1.0
info:
  title: Zeam API Gateway
  version: 1.0.0
  description: >
    The Zeam API Gateway is the single, REST-based external surface for
    registered

    integrators. Every protected request carries a bearer access token (issued
    by the

    Zeam Auth Service) and the application secret header `x-zeam-auth`. The
    gateway

    verifies the token and resolves the caller's association server-side — you
    do not

    need to supply an association id header. Errors use RFC 7807

    `application/problem+json`.
  license:
    name: Proprietary
    url: https://zeam.app
  contact:
    name: Zeam Platform Team
    url: https://zeam.app
servers:
  - url: https://api.zeam.money/gw/v1
    description: >-
      Zeam API Gateway. The sandbox and production environments share this base
      URL; your application's registration determines which one a request runs
      in.
security:
  - BearerAuth: []
    ZeamAuth: []
tags:
  - name: Auth
    description: Public token issuance.
  - name: Wallets
    description: Association wallets with embedded balances.
  - name: Assets
    description: Platform asset registry.
  - name: Beneficiaries
    description: Association beneficiaries and their payment destinations.
  - name: Connectors
    description: Connector discovery (Connect, surfaced as REST).
  - name: Quotes
    description: Off-ramp quotes.
  - name: Payments
    description: >-
      P2P transfers, swaps, and off-ramp cash-outs, plus the compliance
      reference lookups used when building an off-ramp.
  - name: Transactions
    description: Transaction records, the polling and history complement to webhooks.
  - name: Webhooks
    description: Association webhook registrations.
paths:
  /webhooks:
    post:
      tags:
        - Webhooks
      summary: Register a webhook
      description: |
        Registers a webhook for one event type. Exactly one active registration
        is allowed per association and event type; registering a type that
        already has one returns 409, so deactivate the existing one first. The
        URL must be https (plain http is tolerated in the sandbox only).
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
            example:
              url: https://example.com/zeam/webhooks
              type: IntentSuccessful
      responses:
        '201':
          description: Webhook registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookCreated'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/ValidationError'
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  schemas:
    CreateWebhookRequest:
      type: object
      required:
        - url
        - type
      properties:
        url:
          type: string
          format: uri
          description: >-
            HTTPS endpoint that receives events. Plain http is tolerated in the
            sandbox only.
        type:
          $ref: '#/components/schemas/WebhookEventType'
    WebhookCreated:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          format: uuid
          description: The new registration id.
    WebhookEventType:
      type: string
      description: >-
        The event that triggers delivery. One active registration is allowed per
        association and event type.
      enum:
        - IntentInitiated
        - IntentProcessing
        - IntentFailed
        - IntentSuccessful
        - IntentRefunding
        - IntentRefunded
        - IntentRefundFailed
        - IntentCancelled
    Problem:
      type: object
      required:
        - type
        - title
        - status
      description: RFC 7807 problem details.
      properties:
        type:
          type: string
          format: uri
          example: https://errors.zeam.app/validation-error
        title:
          type: string
          example: Validation Error
        status:
          type: integer
          example: 422
        detail:
          type: string
          example: The 'amount' field must be a positive decimal.
        instance:
          type: string
          example: /v1/quotes
        requestId:
          type: string
          example: 01J8Z6K3QW9F2
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    BadRequest:
      description: Malformed request.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: Missing or invalid authentication.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: Authenticated but not permitted.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Conflict:
      description: The request conflicts with existing state.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ValidationError:
      description: Request failed validation.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    UpstreamError:
      description: A downstream service returned an unexpected error.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by POST /v1/auth/token.
    ZeamAuth:
      type: apiKey
      in: header
      name: x-zeam-auth
      description: >-
        Application secret (the apiKey issued at registration), validated at the
        Kong edge.

````