ApivomApivom
Get Demo

WhatsApp Flows API Connector

Meta's WhatsApp Flows API — create, update, publish and deprecate the native in-chat forms of WhatsApp, manage endpoint encryption keys and send draft or published Flows — registered in Apivom Atlas. Apivom Halo delivers your published Flows and reads the completed forms; Flow design and publishing stay in Meta's tools today.

What you can do

  • Flow lifecycle routes: create, update JSON and metadata, preview URL, publish, deprecate, delete, migrate between WABAs
  • Endpoint encryption: set and read the public key used by data-exchange Flows — Halo's own appointment Flow runs on such an encrypted endpoint
  • Send a draft Flow for testing or a published Flow to a customer through the Cloud API messaging routes
  • Halo sends your published Flows as interactive messages and receives the completed form (nfm_reply) with its flow token
  • 29 routes (12 read-only) on graph.facebook.com, documented in the AI integration guide (llms.txt)

Use cases

  • Structured intake inside the conversation — Publish an appointment or address Flow in Meta's builder and let Halo deliver it at the right moment, receiving the submitted fields instead of parsing free text.
  • Version your forms safely — Use the lifecycle routes to publish a new version, deprecate the old one and migrate Flows between business accounts without touching the assistant.

WhatsApp Flows are the structured, multi-screen forms that open inside a WhatsApp chat — booking a slot, capturing an address, running a survey — and the Flows API manages them: create a Flow on a WhatsApp Business Account, upload its JSON, preview, publish, deprecate or delete it, and for data-exchange Flows register the public key your endpoint uses for encryption. The same family covers sending a draft or the published Flow to a customer. Apivom Atlas catalogues 29 of these routes with the credential contract and the AI integration guide (llms.txt). The live Apivom use is on the delivery side: Apivom Halo sends a Flow you have already published as an interactive message on your line and, when the customer submits it, receives the completed form through the webhook as an nfm_reply carrying your flow token, so answers arrive structured. Halo also hosts the encrypted data-exchange endpoint of its appointment Flow: Meta signs each request, Halo decrypts it, checks the organiser's free/busy and answers with the next screen. Designing and publishing Flows is not done through Apivom today — you build them in Meta's Flow Builder or via these routes.

Authentication

A Meta Graph access token (System User recommended) with whatsapp_business_management and whatsapp_business_messaging for the WhatsApp Business Account that owns the Flows, sent as Bearer per request. Encrypted in your tenant; Apivom Atlas stores nothing.

Frequently asked questions

Can I design and publish Flows from Apivom?

Not today. Halo delivers Flows that are already published and reads their completions; creating, updating and publishing them is done in Meta's Flow Builder or with these API routes from your own tooling. Bringing that into a product workflow is scoped per customer.

How does Apivom match a completed form to the right customer?

Each Flow send carries a flow token chosen by Halo; the completion webhook returns the same token with the submitted fields, so the answers are attached to the right conversation and contact.

Does Apivom charge per API call for this connector?

No. Connectors are part of your Apivom tenant and are not metered in the Atlas portal. The vendor's own pricing, quotas and rate limits still apply to the account you connect — Apivom paces its calls to stay inside them and shows every call in your tenant's integration log.

Where are my credentials stored and who can see the traffic?

Apivom Atlas is a stateless gateway: it never stores vendor credentials or tokens. The Apivom product that connects keeps the credential encrypted in your tenant database, and every request and response is logged in your tenant only — your data is never shared across tenants.

More Atlas integrations

AI integration guide (llms.txt)

Machine-readable markdown — feed it to your AI assistant as integration instructions.