Flow Docs
Open Flow AI

Webhooks

Flow AI can send events to a URL you provide. Use webhooks to run your own logic when something happens (for example a new message or a connection accepted).

What are webhooks?

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

Setting up

  1. In Flow AI, go to the place where webhooks are configured (for example in your workspace or account settings).
  2. Add your endpoint URL. It must be a public HTTPS URL that accepts POST requests.
  3. Choose which events you want to receive.
  4. Save. Flow AI will send a test request so you can confirm the endpoint works.

Events

Typical events include new message received, connection accepted, and status changes. Each payload includes the event type and relevant data (for example the conversation or connection id). 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. Webhooks push events to you; the API lets you pull or push on demand.

⌘I