Webhooks
/
Update Webhook

Update Webhook

PATCH
https://api.vivamo.co/v1/operators/webhooks/{webhookId}

Update an existing webhook's URL, status, event types, or custom headers. The HMAC secret key is not changed — to rotate the secret, delete and recreate the webhook. Duplicate webhooks (same URL with overlapping event types) are rejected.

Path parameters

    webhookId
    string
    Required
    The unique identifier of the webhook to update.

Request body

    url
    string
    The new URL to receive webhook POST requests.
    Examples:https://your-app.com/webhooks/vivamo-updated
    status
    string
    Set to "inactive" to pause deliveries without deleting the webhook.
      active
      string
      inactive
      string
    eventTypes
    array of string
    Event types to subscribe to. Omit or pass an empty array to receive all events.
      transaction
      string
      kyc_verification
      string
      customer_w9_required
      string
      customer_w9_completed
      string
    headers
    object
    Custom headers to include with every webhook delivery.
    Examples:{"X-Custom-Auth":"updated_pre_shared_key"}

Response

Webhook updated successfully.
    _id
    string
    Unique webhook ID.
    url
    string
    The updated webhook URL.
    status
    string
    Webhook status.
      active
      string
      inactive
      string
    eventTypes
    array of string
    Subscribed event types.
      transaction
      string
      kyc_verification
      string
      customer_w9_required
      string
      customer_w9_completed
      string
    headers
    object
    Custom headers included with each delivery.
Built with