Event types you must handle
Subscribe to and process these three webhook events:Event | Description |
---|---|
tariff.expiring | Triggered when tariff is nearing its end, usually 7–10 days before expiration. |
tariff.expired | Triggered when the tariff term has expired. |
tariff.fetch.failed | Triggered after a series of failed attempts to sync tariff data from the provider (e.g., due to broken credentials) |
Recommended handling flow
When your backend receives any of the above events:- Capture the webhook payload — your server should parse the event and extract relevant IDs, including
location_id
.  - Notify the customer — send a notification (e.g., in-app or email), referencing the
location_id
from the event, resolved to the postal address. - Prompt action — link notification to Tariff Settings Page in your app to review and resolve issues.
Example webhook payload
Summary workflow
Step | Action |
---|---|
1 | Flatpeak sends a webhook event (tariff.expiring , tariff.expired , or tariff.fetch.failed ) |
2 | Your backend receives and parses the event payload |
3 | You notify the customer and link them to the Tariff Settings Page |
4 | The customer opens the flow and reconnects or updates their tariff |