Flow Types#
- class pywa.types.flows.FlowRequest#
Represents a flow data exchange request. This request is sent to the flow endpoint when a user interacts with a flow and perform an
Action
that trigger a data exchange.Read more at developers.facebook.com.
- Variables:
version (str) β The version of the data exchange.
flow_token (str | None) β The flow token used to create the flow.
None
if action isFlowRequestActionType.PING
.action (pywa.types.flows.FlowRequestActionType) β The action that triggered the request.
screen (str | None) β The screen that triggered the request.
None
if action isFlowRequestActionType.PING
.data (dict[str, Any] | None) β The data sent from the screen.
None
if action isFlowRequestActionType.PING
and optional if action isFlowRequestActionType.BACK
orFlowRequestActionType.INIT
.raw_encrypted (dict[str, str]) β The raw-encrypted data of the request.
- class pywa.types.flows.FlowRequestActionType#
The type the action that triggered the
FlowRequest
.- Variables:
INIT β if the request is triggered when opening the flow (The
FlowButton
was sent with flow_action_type set toFlowActionType.DATA_EXCHANGE
)BACK β if the request is triggered when pressing back (The screen has
refresh_on_back
set toTrue
)DATA_EXCHANGE β if the request is triggered when submitting the screen (And the
Action
name isFlowActionType.DATA_EXCHANGE
)PING β if the request is triggered by a health check (Ignore this requests by leaving
handle_health_check
toTrue
)
- class pywa.types.flows.FlowResponse#
Represents a flow data exchange response. This response is sent to the flow endpoint to determine the next screen to display or to close the flow. You should return this response from your flow endpoint callback.
Read more at developers.facebook.com.
Example
>>> from pywa import WhatsApp >>> from pywa.types.flows import FlowResponse
>>> wa = WhatsApp(business_private_key="...", ...) >>> @wa.on_flow_request("/my-flow-endpoint") ... def my_flow_endpoint(flow_request: FlowRequest) -> FlowResponse: ... return FlowResponse( ... version=flow_request.version, ... screen="SCREEN_ID", ... data={"key": "value"}, ... )
- Variables:
version (str) β The version of the data exchange (You can use the same version as the request (
request.version
)).screen (str | None) β The screen to display (if the flow is not closed).
data (dict[str, Union[str, int, float, bool, dict, pywa.types.flows.DataSource, Iterable[str | int | float | bool | dict | pywa.types.flows.DataSource]]]) β The data to send to the screen or to add to flow completion message (default to empty dict).
error_message (str | None) β This will redirect the user to
screen
and will trigger a snackbar error with the error_message present (if the flow is not closed).flow_token (str | None) β The flow token to close the flow (if the flow is closed).
close_flow (bool) β Whether to close the flow or just navigate to the screen.
- class pywa.types.flows.FlowCategory#
The category of the flow
- Variables:
SIGN_UP β Sign up
SIGN_IN β Sign in
APPOINTMENT_BOOKING β Appointment booking
LEAD_GENERATION β Lead generation
CONTACT_US β Contact us
CUSTOMER_SUPPORT β Customer support
SURVEY β Survey
OTHER β Other
- class pywa.types.flows.FlowDetails#
Represents the details of a flow.
Read more at developers.facebook.com.
- Variables:
id (str) β The ID of the flow.
name (str) β The name of the flow.
status (FlowStatus) β The status of the flow.
updated_at (datetime.datetime | None) β The last time the flow was updated (name, categories, endpoint_uri, json, etc.).
json_version (str | None) β The version of the flow JSON.
data_api_version (str | None) β The version to use during communication with the WhatsApp Flows Data Endpoint.
categories (tuple[FlowCategory, ...]) β The categories of the flow.
validation_errors (tuple[FlowValidationError, ...] | None) β The validation errors of the flow.
endpoint_uri (str | None) β The endpoint URI of the flow.
preview (FlowPreview | None) β The preview of the flow.
whatsapp_business_account (WhatsAppBusinessAccount | None) β The WhatsApp Business Account that owns the flow.
application (FacebookApplication | None) β The application that owns the flow.
- publish() bool #
- Update the status of this flow to
FlowStatus.PUBLISHED
. A shortcut for
pywa.client.WhatsApp.publish_flow()
.
This action is not reversible.
The Flow and its assets become immutable once published.
To update the Flow after that, you must create a new Flow. You specify the existing Flow ID as the clone_flow_id parameter while creating to copy the existing flow.
You can publish your Flow once you have ensured that:
All validation errors and publishing checks have been resolved.
The Flow meets the design principles of WhatsApp Flows
The Flow complies with WhatsApp Terms of Service, the WhatsApp Business Messaging Policy and, if applicable, the WhatsApp Commerce Policy
- Returns:
Whether the flow was published.
- Raises:
FlowPublishingError β If this flow has validation errors or not all publishing checks have been resolved.
- Update the status of this flow to
- delete() bool #
- When the flow is in
FlowStatus.DRAFT
status, you can delete it. A shortcut for
pywa.client.WhatsApp.delete_flow()
.
- Returns:
Whether the flow was deleted.
- Raises:
FlowDeletingError β If this flow is already published.
- When the flow is in
- deprecate() bool #
- When the flow is in
FlowStatus.PUBLISHED
status, you can only deprecate it. A shortcut for
pywa.client.WhatsApp.deprecate_flow()
.
- Returns:
Whether the flow was deprecated.
- Raises:
FlowDeprecatingError β If this flow is not published or already deprecated.
- When the flow is in
- get_assets() tuple[pywa.types.flows.FlowAsset, ...] #
- Get all assets attached to this flow.
A shortcut for
pywa.client.WhatsApp.get_flow_assets()
.
- Returns:
The assets of the flow.
- update_metadata(name: str | None = None, categories: Iterable[FlowCategory | str] | None = None, endpoint_uri: str | None = None) bool #
- Update the metadata of this flow.
A shortcut for
pywa.client.WhatsApp.update_flow_metadata()
.
- Parameters:
name β The name of the flow (optional).
categories β The new categories of the flow (optional).
endpoint_uri β The URL of the FlowJSON Endpoint. Starting from FlowJSON 3.0 this property should be specified only gere. Do not provide this field if you are cloning a FlowJSON with version below 3.0.
Example
>>> from pywa.types.flows import FlowCategory >>> wa = WhatsApp(business_account_id='1234567890', ...) >>> my_flows = wa.get_flows() >>> my_flows[0].update_metadata( ... name='Feedback', ... categories=[FlowCategory.SURVEY, FlowCategory.OTHER], ... endpoint_uri='https://my-api-server/feedback_flow' ... )
- Returns:
Whether the flow was updated.
- Raises:
ValueError β If neither
name
,categories
orendpoint_uri
is provided.
- update_json(flow_json: FlowJSON | dict | str | Path | bytes | BinaryIO) bool #
- Update the json of this flow.
A shortcut for
pywa.client.WhatsApp.update_flow_json()
.
- Parameters:
flow_json β The new json of the flow. Can be a
FlowJSON
object,dict
, jsonstr
, json file path or json bytes.- Returns:
Whether the flow was updated.
- Raises:
FlowUpdatingError β If the flow json is invalid or this flow is already published.
- class pywa.types.flows.FlowStatus#
The status of the flow
- Variables:
DRAFT β This is the initial status. The Flow is still under development. The Flow can only be sent with βmodeβ: βdraftβ for testing.
PUBLISHED β The Flow has been marked as published by the developer so now it can be sent to customers. This Flow cannot be deleted or updated afterwards.
DEPRECATED β The developer has marked the Flow as deprecated (since it cannot be deleted after publishing). This prevents sending and opening the Flow, to allow the developer to retire their endpoint. Deprecated Flows cannot be deleted or deprecated.
BLOCKED β Monitoring detected that the endpoint is unhealthy and set the status to Blocked. The Flow cannot be sent or opened in this state; the developer needs to fix the endpoint to get it back to Published state (more details in Flows Health and Monitoring).
THROTTLED β
Monitoring detected that the endpoint is unhealthy and set the status to Throttled. Flows with throttled status can be opened, however only 10 messages of the Flow could be sent per hour. The developer needs to fix the endpoint to get it back to the PUBLISHED state (more details in Flows Health and Monitoring on developers.facebook.com).
- class pywa.types.flows.FlowPreview#
Represents the preview of a flow.
- Variables:
url (str) β The URL to the preview.
expires_at (datetime.datetime) β The expiration date of the preview.
- class pywa.types.flows.FlowValidationError#
Represents a validation error of a
FlowJSON
.- Variables:
error (str) β The error code.
error_type (str) β The type of the error.
message (str) β The error message.
line_start (int) β The start line of the error.
line_end (int) β The end line of the error.
column_start (int) β The start column of the error.
column_end (int) β The end column of the error.
- class pywa.types.flows.FlowAsset#
Represents an asset in a flow.
Read more at developers.facebook.com.
- class pywa.types.flows.FlowTokenNoLongerValid#
This exception need to be returned or raised from the flow endpoint callback when the Flow token is no longer valid.
Example
>>> from pywa.types.flows import FlowTokenNoLongerValid >>> raise FlowTokenNoLongerValid(error_message='The order has already been placed')
The layout will be closed and the
FlowButton
will be disabled for the user. You can send a new message to the user generating a new Flow token. This action may be used to prevent users from initiating the same Flow again.You are able to set an error message to display to the user. e.g. βThe order has already been placedβ
- class pywa.types.flows.FlowRequestSignatureAuthenticationFailed#
This exception need to be returned or raised from the flow endpoint callback when the request signature authentication fails.
A generic error will be shown on the client.
- pywa.utils.FlowRequestDecryptor#
Type hint for the function that decrypts the request from WhatsApp Flow.
All parameters need to be positional.
See
default_flow_request_decryptor()
source code for an example.
- Parameters:
- Returns:
tuple[dict, bytes, bytes] - decrypted_data (dict): decrypted data from the request - aes_key (bytes): AES key you should use to encrypt the response - iv (bytes): initial vector you should use to encrypt the response
- pywa.utils.FlowResponseEncryptor#
Type hint for the function that encrypts the response to WhatsApp Flow.
All parameters need to be positional.
See
default_flow_response_encryptor()
source code for an example.
- pywa.utils.default_flow_request_decryptor(encrypted_flow_data_b64: str, encrypted_aes_key_b64: str, initial_vector_b64: str, private_key: str, password: str = None) tuple[dict, bytes, bytes] #
The default global decryption function for decrypting data exchange requests from WhatsApp Flow.
This implementation follows the
FlowRequestDecryptor
type hint.This implementation requires
cryptography
to be installed. To install it, runpip3 install 'pywa[cryptography]'
orpip3 install cryptography
.This implementation was taken from the official documentation at developers.facebook.com.
Example
Set the default global decryptor (This is indeed the default):
>>> from pywa.utils import default_flow_request_decryptor >>> from pywa import WhatsApp >>> wa = WhatsApp(flows_request_decryptor=default_flow_request_decryptor, ...)
Set the decryptor for a specific flow:
>>> from pywa import WhatsApp >>> from pywa.types.flows import FlowRequest, FlowResponse >>> from pywa.utils import default_flow_request_decryptor >>> wa = WhatsApp(...) >>> @wa.on_flow_request("/sign-up-flow", request_decryptor=default_flow_request_decryptor) ... def on_sign_up_request(_: WhatsApp, flow: FlowRequest) -> FlowResponse | None: ...
- pywa.utils.default_flow_response_encryptor(response: dict, aes_key: bytes, iv: bytes) str #
The default global encryption function for encrypting data exchange responses to WhatsApp Flow.
This implementation follows the
FlowResponseEncryptor
type hint.This implementation requires
cryptography
to be installed. To install it, runpip3 install 'pywa[cryptography]'
orpip3 install cryptography
.This implementation was taken from the official documentation at developers.facebook.com.
Example
Set the default global encryptor (This is indeed the default):
>>> from pywa.utils import default_flow_response_encryptor >>> from pywa import WhatsApp >>> wa = WhatsApp(flows_response_encryptor=default_flow_response_encryptor, ...)
Set the encryptor for a specific flow:
>>> from pywa import WhatsApp >>> from pywa.types.flows import FlowRequest, FlowResponse >>> from pywa.utils import default_flow_response_encryptor >>> wa = WhatsApp(...) >>> @wa.on_flow_request("/sign-up-flow", response_encryptor=default_flow_response_encryptor) ... def on_sign_up_request(_: WhatsApp, flow: FlowRequest) -> FlowResponse | None: ...