Home
WhatsApp
Whatsapp Flows Api Flow Structure
Whatsapp Flows Api Flow Structure
Flow from WhatsApp API
Type: object
Properties: 10
Flow is a JSON Structure definition published by WhatsApp, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
id
name
status
categories
validation_errors
json_version
data_api_version
endpoint_uri
preview
whatsapp_business_account
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/whatsapp/refs/heads/main/json-structure/whatsapp-flows-api-flow-structure.json",
"name": "Flow",
"description": "Flow from WhatsApp API",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "wamid.abc123"
},
"name": {
"type": "string",
"example": "Example Business"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED",
"DEPRECATED",
"BLOCKED",
"THROTTLED"
],
"example": "DRAFT"
},
"categories": {
"type": "array",
"items": {
"type": "string",
"enum": [
"SIGN_UP",
"SIGN_IN",
"APPOINTMENT_BOOKING",
"LEAD_GENERATION",
"CONTACT_US",
"CUSTOMER_SUPPORT",
"SURVEY",
"OTHER"
]
}
},
"validation_errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowValidationError"
}
},
"json_version": {
"type": "string",
"example": "example_value"
},
"data_api_version": {
"type": "string",
"example": "example_value"
},
"endpoint_uri": {
"type": "string",
"format": "uri",
"example": "example_value"
},
"preview": {
"type": "object",
"properties": {
"preview_url": {
"type": "string",
"format": "uri"
},
"expires_at": {
"type": "datetime"
},
"id": {
"type": "string"
}
}
},
"whatsapp_business_account": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}