Skip to main content
To start a new Connect session, make a request as shown in the example below. All requests are authenticated using the connect_token provided in the response when you created the session. Unlike a traditional REST API, Connect uses a single endpoint (https://connect.flatpeak.com) for all interactions. The current operation is determined by the route field in the request or response body rather than the URL path. To start the session, set the route to session_start. Connect is designed as a dynamic, multi-step workflow that adapts to different providers, tariffs, and customer journeys. The route field identifies the current step in the flow and determines which data should be displayed or collected next. Your application should be able to handle any route returned by the API and render the corresponding experience for the customer. The action field determines which workflow the customer will enter:
ActionResult
TARIFFStarts the tariff connection flow.
VPPStarts the VPP connection flow.
The TARIFF flow is required: every Connect implementation must support tariff connection. The VPP flow is optional. Implement it only if you would like to VPP support.
curl --request POST \
  --url https://connect.flatpeak.com \
  --header 'Content-Type: application/json' \
  --data '{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "session_start",
  "action": "TARIFF"
}'
Make sure you subscribe to the connect_session.complete events via webhooks so your system is notified when a customer completes the flow.
Contact support for implementation guidance.