Create real-time notification alert

1 min

POST

https://app.amberflo.io/notifications

Creates a new real-time notification for monitoring usage and revenue events. Use this endpoint to set up alerts that trigger when specified thresholds are met, such as usage exceeding limits or costs reaching budget thresholds.

Notifications can be sent via email or webhook, with customizable frequency and filtering options. The notification will begin monitoring immediately upon creation if enabled.

For details on what are notifications, see the guide. For details on the notification types, see the detailed walkthrough.

Important Note: Each time an alert is sent, it is logged in the Account Event API.

bodyobjectRequest payload for creating a new notification alert with threshold monitoring configuration.

200Notification 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/notifications \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "name": "Too many api calls",
     "description": "Alert on too many api calls",
     "notificationType": "usage",
     "meterId": "24ad0b40-a217-11eb-b01a-19ff91d9370d",
     "frequency": "every 1h",
     "webhookUrl": "https://hooks.slack.com/services/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",
     "email": [
     "[email protected]"
     ],
     "thresholdCondition": "greater-than",
     "thresholdValue": 1000,
     "range": "day",
     "customerFilterMode": "*",
     "enabled": true
     }'