2026-08-11. Learn more: Versioning
Flow lifecycle
GET /v1/flows/{id}returns the Flow’s status in Meta (metaStatus), its screens, fields and submit action.POST /v1/flows/{id}/publish?dry_run=truechecks a Flow without publishing it.POST /v1/flows/{id}/deprecateretires a Flow in Meta. Meta cannot undo this. Flowella blocks it while templates still use the Flow, unless you sendforce.DELETE /v1/flows/{id}returns409HUBSPOT_FLOW_MANAGEDfor a Flow built from a HubSpot form, and409FLOW_REFERENCED_BY_TEMPLATESwhile a template draft still uses the Flow. Deleting a Flow never deletes it in Meta: deprecate it first to retire it there. Publishing a deprecated Flow returns409FLOW_DEPRECATED.- When you create a template, a Flow button can point to a Flowella Flow with
flowellaFlowIdinstead of a Meta Flow ID. - Flows you create through the API publish with the entry screen
MAIN_FORM. Flows you published earlier keep working. Republish them before you use them withflowellaFlowId.
Webhooks
- New
flow.status_updatedevent when a Flow’s status in Meta changes, for example when it is deprecated. Subscribe to it in Settings → Webhooks. Event types
Credentials
GET /v1/pingreturns how you are signed in, your scopes and, for apps, the client ID. Check your credentials- Replayed idempotent responses include the
Idempotent-Replayed: trueheader. Idempotency
MCP server
- AI assistants can connect to the Flowella MCP server by signing in, without an API key. The user chooses an organisation and selects Allow access on the Flowella consent screen. Connections from members who are not an Owner or Admin are read-only. Developer apps
- Installed apps is now AI assistants, with a Last token column. Review and revoke installed apps
- Flowella MCP server. AI assistants that support the Model Context Protocol can read your channels, templates and Flows. The server is read-only and uses an organisation API key. API keys
GET /v1/flows/{id}accepts the Flowella form ID. Editing the schema of a Flow built from a HubSpot form returns409: make the change in HubSpot and sync again. Flowella REST API- Flows built in Flowella can send each submission to one of your webhook endpoints, set on the Flow’s Settings tab. Webhooks
- Registering a developer app with an invalid redirect URI returns a plain-language error. Register an app
Breaking changes
-
API-Versionaccepts only2026-08-11. Any other value returns400. Leave the header out, or send2026-08-11. Versioning - Webhook endpoints need a public HTTPS URL. Private, loopback and cloud metadata addresses are not accepted. Check every endpoint before you upgrade. Adding a webhook endpoint
-
OAuth apps. Review these requirements before you upgrade an app built on Flowella OAuth:
- Requests without a scope get read-only access, and unknown scopes are rejected.
- The token, introspect and revoke endpoints require client authentication.
- The authorise request requires
state. - Client credentials grants do not return a refresh token.
- Revoking a token revokes only that token’s family.
API
- Error responses include a
requestIdinsideerror, which you can quote to support. Errors - Creating a contact returns
201and updating one returns200. A duplicateexternalIdreturns409, and a deleted contact returns404.
Webhooks
- New
contact.created,contact.updatedandcontact.deletedevents. Event types - Give each endpoint a name with Name (optional). The name appears above the URL in the list.
- For 24 hours after you rotate a signing secret, Flowella also signs each delivery with the old secret and sends it in
X-Flowella-Signature-Previous, so you can switch secrets without dropping events. Rotate a signing secret - A redelivered event keeps its original event ID and timestamp. API delivery records include the correlation ID, response headers and next retry time. Deduplicate events
- Organisation owners get a single notification when Flowella pauses a failing endpoint. Retries and back-off
- Use
https://api.flowella.io. Requests tohttps://api.flowella.io/v1/...return JSON. Oldhttps://app.flowella.io/api/v1/...URLs, including the OpenAPI document, permanently redirect to the API host. Update your base URL so you do not rely on the redirect. Base URL - The first server in the OpenAPI document is
https://api.flowella.io, so imported collections call the right base URL. OpenAPI spec - The API rejects invalid template components, and templates over Meta’s submission limits, before they reach Meta.
- You can create and send carousel templates through the API. If you do not pass media for a card, Flowella uses that card’s approved sample. Carousel templates
- Fallback values for template variables apply to API sends. Fallback values
- The Developer hub includes complete guides and a Postman collection. Developer hub
API
- Repeat sends of the same template through the API go out faster.
- When Meta throttles a template management call, Flowella reports it as a rate limit, so your retries back off correctly. Rate limits
BreakingAPI
POST /v1/templates/sendreturns202. Flowella accepts the request, returns a job ID straight away and delivers the messages in the background, retrying temporary WhatsApp errors. If your integration checks for a200response, update it to expect202with"status": "accepted". Follow delivery on the template’s Statistics tab. Bulk template sendsIdempotency-Key. Send anIdempotency-Keyheader withPOST /v1/templates/sendand Flowella recognises repeats of the same request for seven days, returning the original job ID instead of sending again. Idempotency
API
- REST v1 is documented and served on the dedicated API host at
/v1/.... Flowella REST API

