Skip to main content
After a customer completes the Connect flow, Flatpeak continually synchronises their tariff data. If any action is needed, Flatpeak sends events via webhooks to your backend so you can notify customers and prompt corrective steps.

​
Event types you must handle

Subscribe to and process these three webhook events:
EventDescription
tariff.expiringTriggered when tariff is nearing its end, usually 7–10 days before expiration.
tariff.expiredTriggered when the tariff term has expired.
tariff.fetch.failedTriggered after a series of failed attempts to sync tariff data from the provider (e.g., due to broken credentials)
To subscribe to these events, go to Dashboard Webhooks page. When your backend receives any of the above events:
  1. Capture the webhook payload — your server should parse the event and extract relevant IDs, including location_id. 
  2. Notify the customer — send a notification (e.g., in-app or email), referencing the location_id from the event, resolved to the postal address.
  3. Prompt action — link notification to Tariff Settings Page in your app to review and resolve issues.

​
Example webhook payload

{
  "id": "evt_66167787c1652b3fbeba5f01",
  "object": "event",
  "type": "tariff.expiring",
  "data": {
    "tariff_id": "trf_6597ef46529ab4467502af0b",
    "location_id": "loc_661677cdc31d91695fd8f33d",
    "customer_id": "cus_65e421d1daa4a24082b4f590"
  },
  "time_created": "2024-02-01T11:25:39Z"
}

​
Summary workflow

StepAction
1Flatpeak sends a webhook event (tariff.expiring, tariff.expired, or tariff.fetch.failed)
2Your backend receives and parses the event payload
3You notify the customer and link them to the Tariff Settings Page
4The customer opens the flow and reconnects or updates their tariff
⌘I