Skip to main content
GET
Get a WhatsApp Flow by id

Endpoint

Required scope

flows:read

Path parameters

Example request

curl

Response

200 OK

Same shape as one entry of GET /v1/flows.

400 Bad Request

INVALID_FLOW_ID — the id is not a valid Keebai identifier.

404 Not Found

FLOW_NOT_FOUND — no Flow with that id in this project.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

Keebai flow id.

channel_id
string
required

Keebai channel this Flow belongs to.

name
string
required
categories
enum<string>[]
required
Available options:
OTHER,
SIGN_UP,
SIGN_IN,
APPOINTMENT_BOOKING,
LEAD_GENERATION,
CONTACT_US,
CUSTOMER_SUPPORT,
SURVEY
status
enum<string>
required
Available options:
draft,
published,
archived
description
string | null
meta_flow_id
string | null

Meta Flow id. Use it as flow_id when sending a message of type flow. Null until Meta accepts the Flow.

flow_data
object

Flow JSON currently stored in Keebai.

metadata
object
created_at
string<date-time> | null
updated_at
string<date-time> | null