Skip to main content

​
Webhook Endpoints API

Webhook endpoints receive normalized billing events from the Subscriptions Engine.

​
POST /auth/set-webhook-url

Set the webhook URL for a tenant. 
curl -X POST https://nombasub.oluwadunsin.dev/auth/set-webhook-url \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: sub_xxx" \
  -d '{
    "webhookUrl": "https://merchant.example.com/webhooks/nombasub"
  }'

​
Request body

FieldTypeRequiredDescription
webhookUrlstringYesPublic HTTPS endpoint that receives webhooks.

​
Response

{
  "status": "success",
  "message": "Webhook URL set successfully",
  "data": {
    "webhookSecret": "whsec_64_character_secret"
  }
}

​
Delivery headers

Webhook deliveries include:
HeaderDescription
x-nombasub-eventEvent type, such as invoice.paid.
x-nombasub-webhook-idUnique delivery ID.
x-nombasub-tenant-idTenant ID.
x-nombasub-timestampDelivery timestamp.
x-nombasub-signatureSignature when a webhook secret is configured.
See Configure Merchant Webhooks and Webhook Events.