Class ActionNavigateFlow

Action API object

Hierarchy (View Summary)

Constructors

constructor

Properties

name parameters

Constructors

constructor

  • new ActionNavigateFlow(
        flow_token: string,
        flow_id: string,
        flow_cta: string,
        screen: string,
        data?: unknown,
        mode?: "published" | "draft",
        flow_message_version?: "3",
    ): ActionNavigateFlow

  • Builds a navigate flow component for an Interactive message

    Parameters

    • flow_token: string

      Flow token that is generated by the business to serve as an identifier

    • flow_id: string

      ID of the Flow provided by WhatsApp

    • flow_cta: string

      Text on the CTA button, character limit - 20 characters (no emoji)

    • screen: string

      The ID of the first Screen

    • Optionaldata: unknown

      Optional input data for the first Screen of the Flow. If provided, this must be a non-empty object.

    • mode: "published" | "draft" = "published"

      The Flow can be in either "draft" or "published" mode

    • flow_message_version: "3" = "3"

      The Flow version, must be "3"

    Returns ActionNavigateFlow

    Throws

    If flow_cta is empty or over 20 characters

    Throws

    If flow_cta contains emojis

    Throws

    If data is provided and is an empty object

Properties

Readonlyname

name: "flow"

The name of the component

Readonlyparameters

parameters: {
    flow_action: "navigate" | "data_exchange";
    flow_action_payload?: { data?: unknown; screen: string };
    flow_cta: string;
    flow_id: string;
    flow_message_version: "3";
    flow_token: string;
    mode: "published" | "draft";
} & (
    | {
        flow_action: "navigate";
        flow_action_payload: { data?: unknown; screen: string };
    }
    | { flow_action: "data_exchange"; flow_action_payload?: undefined }
)

The Flow parameters

Type declaration

  • flow_action: "navigate" | "data_exchange"

    The Flow type, if set to "navigate", flow_action_payload must be provided

  • Optionalflow_action_payload?: { data?: unknown; screen: string }

    Required if flow_action is "navigate", should be omitted otherwise

    • Optionaldata?: unknown

      Optional input data for the first Screen of the Flow. If provided, this must be a non-empty object.

    • screen: string

      The ID of the first Screen

  • flow_cta: string

    Text on the CTA button, character limit - 20 characters (no emoji)

  • flow_id: string

    Unique ID of the Flow provided by WhatsApp

  • flow_message_version: "3"

    The Flow version, must be 3

  • flow_token: string

    Flow token that is generated by the business to serve as an identifier

  • mode: "published" | "draft"

    The Flow can be in either draft or published mode

  • {
        flow_action: "navigate";
        flow_action_payload: { data?: unknown; screen: string };
    }
  • { flow_action: "data_exchange"; flow_action_payload?: undefined }

Remarks

TSDoc is unable to document this type properly, so most of the documentation is in the subclasses constructors instead.

Settings

Member Visibility

On This Page

Constructors
Properties