whats_app_flows

Creates, updates, deletes, gets or lists a whats_app_flows resource.

Overview

Name	whats_app_flows
Type	Resource
Id	aws.socialmessaging.whats_app_flows

Fields

The following fields are returned by SELECT queries:

get_whats_app_flow

Name	Datatype	Description
application	object	The Meta application information associated with this Flow.
categories	array	The categories that classify the business purpose of the Flow.
data_api_version	string	The data API version for data exchange endpoint Flows.
endpoint_uri	string	The endpoint URI for data exchange Flows, if configured.
flow_id	string	The unique identifier of the Flow. (pattern: <code>[0-9]+</code>)
flow_name	string	The name of the Flow.
flow_status	string	The lifecycle status of the Flow. Valid values are DRAFT, PUBLISHED, DEPRECATED, BLOCKED, and THROTTLED.
health_status	object	The health status information for this Flow from Meta.
json_version	string	The version of the Flow JSON schema used by this Flow (for example, 7.3).
preview	object	The preview URL and its expiration timestamp for testing the Flow.
validation_errors	array	A list of validation errors from Meta, if any.
whats_app_business_account	object	The WhatsApp Business Account information from Meta associated with this Flow.

list_whats_app_flows

Name	Datatype	Description
flow_categories	array	The categories that classify the business purpose of the Flow.
flow_id	string	The unique identifier of the Flow assigned by Meta. (pattern: <code>[0-9]+</code>)
flow_name	string	The name of the Flow.
flow_status	string	The lifecycle status of the Flow (DRAFT, PUBLISHED, DEPRECATED, BLOCKED, or THROTTLED).
validation_errors	array	A list of validation errors from Meta, if any.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_whats_app_flow	select	id, flowId, region		Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.
list_whats_app_flows	select	id, region	nextToken, maxResults	Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.
create_whats_app_flow	insert	region, id, flowName, categories		Creates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences that users can complete without leaving WhatsApp. The Flow is created in DRAFT status. If publish is set to true and a valid flowJson is provided, the Flow is published immediately.
update_whats_app_flow	update	region, id, flowId		Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update the Flow JSON.
delete_whats_app_flow	delete	id, flowId, region		Deletes a WhatsApp Flow permanently. Only Flows in DRAFT status can be deleted. Published or deprecated Flows cannot be deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
flowId	string	The unique identifier of the Flow to delete.
id	string	The ID of the WhatsApp Business Account associated with this Flow.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next page of results.

SELECT examples

get_whats_app_flow

Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.

SELECT
application,
categories,
data_api_version,
endpoint_uri,
flow_id,
flow_name,
flow_status,
health_status,
json_version,
preview,
validation_errors,
whats_app_business_account
FROM aws.socialmessaging.whats_app_flows
WHERE id = '{{ id }}' -- required
AND flowId = '{{ flowId }}' -- required
AND region = '{{ region }}' -- required
;

list_whats_app_flows

Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.

SELECT
flow_categories,
flow_id,
flow_name,
flow_status,
validation_errors
FROM aws.socialmessaging.whats_app_flows
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_whats_app_flow

Creates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences that users can complete without leaving WhatsApp. The Flow is created in DRAFT status. If publish is set to true and a valid flowJson is provided, the Flow is published immediately.

INSERT INTO aws.socialmessaging.whats_app_flows (
id,
flowName,
categories,
flowJson,
publish,
cloneFlowId,
region
)
SELECT 
'{{ id }}' /* required */,
'{{ flowName }}' /* required */,
'{{ categories }}' /* required */,
'{{ flowJson }}',
{{ publish }},
'{{ cloneFlowId }}',
'{{ region }}'
RETURNING
flow_id,
validation_errors
;

Manifest

# Description fields are for documentation purposes
- name: whats_app_flows
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the whats_app_flows resource.
  - name: id
    value: "{{ id }}"
  - name: flowName
    value: "{{ flowName }}"
  - name: categories
    value:
      - "{{ categories }}"
  - name: flowJson
    value: "{{ flowJson }}"
  - name: publish
    value: {{ publish }}
  - name: cloneFlowId
    value: "{{ cloneFlowId }}"

UPDATE examples

update_whats_app_flow

Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update the Flow JSON.

UPDATE aws.socialmessaging.whats_app_flows
SET 
id = '{{ id }}',
flowId = '{{ flowId }}',
flowName = '{{ flowName }}',
categories = '{{ categories }}'
WHERE 
region = '{{ region }}' --required
AND id = '{{ id }}' --required
AND flowId = '{{ flowId }}' --required;

DELETE examples

delete_whats_app_flow

Deletes a WhatsApp Flow permanently. Only Flows in DRAFT status can be deleted. Published or deprecated Flows cannot be deleted.

DELETE FROM aws.socialmessaging.whats_app_flows
WHERE id = '{{ id }}' --required
AND flowId = '{{ flowId }}' --required
AND region = '{{ region }}' --required
;