Notifications
A subscription tells you about its runs through notification channels — webhooks and/or emails. Set them with the notifications array when you create or update a subscription.
Channels
Webhook
POST to a URL you control on each event. request_type defaults to post; optional headers and payload. Default notify_on is completed and failed.
A templated Similarweb email to 1–20 recipients. Default notify_on is expiring_soon
Events
completed | A run finishes successfully. |
failed | A run ends in any failure state (error, |
| 14 days before the subscription expires. Email channels only. |
all | Any of the above. |
The value error is still accepted as a deprecated alias for failed.
Limits
Channels per subscription | 10 |
Webhook channels | 5 |
Recipients per email channel | 20 |
Expiry-warning lead time | 14 days |
Expiry warnings are automatic.
Even if you don't configure an email channel, Similarweb automatically emails the account owner before a subscription expires, so a subscription never lapses silently. This default reminder isn't returned in subscription responses; add your own email channel to control who receives expiry warnings.
Example
"notifications": [
{
"type": "webhook",
"url": "https://example.com/hooks/sw",
"notify_on": ["completed", "failed"]
},
{
"type": "email",
"recipients": ["analytics@example.com"],
"notify_on": ["expiring_soon"]
}
]
On this page
- Notifications