Create webhook subscription

1 min

POST

https://app.amberflo.io/webhook

Creates a webhook subscription to receive HTTP POST requests when events occur on your Amberflo account. Use this endpoint to set up real-time event notifications for billing events, usage updates, and other account activities.

The webhook payload format is:

{
  "topic": <topic name>,
  "eventTime": <when the event happened, in milliseconds since UNIX epoch>,
  "eventId": <unique-per-topic event id>,
  "data": <data pertaining to the specific event>
}

Key behaviors:

Only one subscription per topic is allowed
The system makes a limited number of delivery attempts with exponential backoff
Your endpoint should be idempotent as it may receive duplicate requests
All delivery attempts are logged in the Account Event API

To test your webhook setup, see the test endpoint.

bodyobjectRequest body for creating a new webhook endpoint subscription

200Webhook subscription successfully created with assigned ID and configuration details

400Invalid request parameters or malformed request body

401Missing or invalid API key authentication

403Insufficient permissions to access this resource

500Internal server error occurred while processing request

curl --request POST \
     --url https://app.amberflo.io/webhook \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "enabled": true,
     "topic": "",
     "destinationUrl": "",
     "transformTemplate": "",
     "authHeader": []
     }'