Create a notification

1min
POST
https://app.amberflo.io/notifications
Set up a new real-time notification on usage and revenue events.
For details on what are notifications, see the guide.
For details on the notification types, see the detailed walkthrough.
Each time an alert is sent, it is logged in the Account Event API.
Authentication
x-api-key
apiKey
Body Parameters
body
notification-post-request
name
string
*
description
string
notificationType
string<usage | invoice | prepaid | pay-as-you-go-promotion | product-item-units | product-item-price | undefined-meter | undefined-customer>
meterId
string
cron
string
frequency
string
webhookUrl
string
webhookHeaders
string
webhookPayload
string
email
string[]
emailToCustomer
boolean
filter
map<string, string[]>
customSubject
string
thresholdCondition
string<less-than | greater-than | equals | percent-change | always-true | less-than-percent | greater-than-percent>
thresholdValue
number
range
string<hour | day | week | month>
customerFilterMode
string<* | per-customer | specific-customer>
customerId
string
productPlanId
string
enabled
boolean
Responses
200
Successful response
notification-response
All Of
notification-put-request  +
id
string
*
name
string
*
description
string
notificationType
string<usage | invoice | prepaid | pay-as-you-go-promotion | product-item-units | product-item-price | undefined-meter | undefined-customer>
meterId
string
cron
string
frequency
string
webhookUrl
string
webhookHeaders
string
webhookPayload
string
email
string[]
emailToCustomer
boolean
filter
map<string, string[]>
customSubject
string
thresholdCondition
string<less-than | greater-than | equals | percent-change | always-true | less-than-percent | greater-than-percent>
thresholdValue
number
range
string<hour | day | week | month>
customerFilterMode
string<* | per-customer | specific-customer>
customerId
string
productPlanId
string
enabled
boolean
createTime
integer
updateTime
integer
﻿
﻿
Updated 30 Sep 2024
Did this page help you?
Get customer lifecycle stage history by id
Get a list of notifications