Jump to Content

Developer Forum Developer Blog Atlas

Guides API Reference What's New Discussions

v1.0

Developer Forum Developer Blog Atlas Log In

API Reference

v1.0Guides API Reference What's New Discussions

Flow Socket API

Getting started with the Flow Socket API
Flow Socket API audience
Nonce overview
- Get a nonceget
Open a connection
Common message/event format
Keep alive
Sending messages (Flow Socket)
Receiving messages (Flow Socket)
Flow Socket API example

Flow Rest API

Introduction to the Flow REST API
Flow REST API audience
You call us, we'll call you
- Synchronous responses
Sending messages (Flow REST)
Loading messages
- Get a list of messagesget
- Get a list of threadsget
Conversation control
- Handover actionpost
- Resolve Actionpost
Triggering events
- Get a list of Eventsget
- Trigger an Eventpost
Business Hoursget
Bot Control
Broadcast
Webhooks
Flow REST API example

Flow Management API

Authentication (Flow Management)
Flows

Flow Socket API

Getting started with the Flow Socket API
Flow Socket API audience
Nonce overview
- Get a nonceget
Open a connection
Common message/event format
Keep alive
Sending messages (Flow Socket)
Receiving messages (Flow Socket)
Flow Socket API example

Flow Rest API

Introduction to the Flow REST API
Flow REST API audience
You call us, we'll call you
- Synchronous responses
Sending messages (Flow REST)
Loading messages
- Get a list of messagesget
- Get a list of threadsget
Conversation control
- Handover actionpost
- Resolve Actionpost
Triggering events
- Get a list of Eventsget
- Trigger an Eventpost
Business Hoursget
Bot Control
Broadcast
Webhooks
Flow REST API example

Flow Management API

Authentication (Flow Management)
Flows

Flow REST endpoint URLs

Learn about the base URL format used with the Flow REST API.

All the URLs referenced in the REST API have the following base:

https://api.flow.ai/rest/v1/