Flow Docs
Open Flow AI

Webhooks

Coming soon. Webhooks are on our roadmap, currently in production, and will be live soon.

Once webhooks are live, Flow AI will be able to send events to a URL you provide. You’ll be able to run your own logic when something happens (for example a new message or a connection accepted).

Coming soon. Webhooks aren’t live yet. Today you can pull data with the API, or have your AI assistant pass it to your other tools. See Using Flow with your CRM.

What are webhooks?

A webhook is an HTTP request that Flow AI will send to your server when an event occurs. You’ll give us a URL; when the event happens, we’ll POST a payload to that URL. Your app will then be able to update a CRM, notify your team, or trigger any other workflow.

How setup will work

Webhooks will be part of Flow AI’s programmatic surface, so they’ll use the same API credentials. You can already create an API key today in Settings → Connect AI Assistant.

Settings → Connect AI Assistant, where you create the API key used to authenticate webhook and API integrations
Webhooks will share the same keys as the API — create one in Settings → Connect AI Assistant.

Once webhooks are live, you’ll be able to:

  1. Register your endpoint URL. It will need to be a public HTTPS URL that accepts POST requests.
  2. Choose which events you want to receive.
  3. Get a test request from Flow AI to confirm your endpoint works, then receive events as they happen.

Events

Planned events include new message received, connection accepted, and status changes. Each payload will include the event type and relevant data (for example the conversation or connection id). Your endpoint will respond with a 2xx status so we know you received the event. If we get repeated failures we may stop sending to that URL until you fix it.

Related

Use the API to read or write data. Once live, webhooks will push events to you; the API lets you pull or push on demand.

⌘I