Resource

Flows

Native WhatsApp Flows — multi-screen forms rendered in-app with typed submissions.

#About

Flows are Meta's native form primitive. Use them for onboarding, lead capture and feedback — the user never leaves WhatsApp, and you get a structured JSON submission when they finish.

#Endpoints

GET/whatsapp/flowsList WhatsApp Flows with their publish status.
POST/whatsapp/flowsCreate a flow from the WhatsApp Flow JSON schema.
POST/whatsapp/flows/:id/publishPublish a draft flow.
GET/whatsapp/flows/:id/submissionsList submissions from users who completed the flow.

GET/whatsapp/flows

List WhatsApp Flows with their publish status.

SDK

TypeScript

const { flows } = await zaptick.flows.list();

POST/whatsapp/flows

Create a flow from the WhatsApp Flow JSON schema.

SDK

TypeScript

await zaptick.flows.create({
  name: 'Lead capture',
  categories: ['SIGN_UP'],
  schema: {
    version: '4.0',
    screens: [/* ... your flow screens ... */],
  },
});

POST/whatsapp/flows/:id/publish

Publish a draft flow.

SDK

TypeScript

await zaptick.flows.publish('flw_01J3...');

GET/whatsapp/flows/:id/submissions

List submissions from users who completed the flow.

SDK

TypeScript

const { submissions } = await zaptick.flows.listSubmissions('flw_01J3...');

Response

JSON

{
  "submissions": [
    {
      "id": "sub_01J3...",
      "flowId": "flw_01J3...",
      "contactPhone": "+919876...",
      "payload": { "email": "priya@example.com", "role": "founder" },
      "submittedAt": "2026-04-21T11:04:22.000Z"
    }
  ]
}