Webhooks
/
Register Webhook

Register Webhook

POST
https://api.vivamo.co/v1/operators/webhooks

Register a webhook URL to receive event notifications for payments, disbursements, and KYC events. Returns a one-time HMAC-SHA512 secret key for signature verification. Optionally include custom headers sent with each delivery.

Request body

    url
    string
    Required
    The URL to receive webhook POST requests.
    Examples:https://your-app.com/webhooks/vivamo
    headers
    object
    Custom headers to include with every webhook delivery (e.g. a pre-shared authentication key).
    Examples:{"X-Custom-Auth":"your_pre_shared_key"}

Response

Webhook registered successfully. The response includes the generated secret key for signature verification.
    _id
    string
    Unique webhook ID.
    url
    string
    The registered webhook URL.
    status
    string
    Webhook status.
      active
      string
      inactive
      string
    secretKey
    string
    HMAC-SHA512 signing key. Store this securely — it is only returned once at creation time.
    headers
    object
    Custom headers included with each delivery.
Built with