Get Started Guide with Gupshup Flow Management APIs

ℹ️

Only flow without endpoint is supported. Flow with endpoint is not supported.

WhatsApp Flows is a way to build structured interactions for business messaging. With Flows, businesses can define, configure, and customize messages with rich interactions that give customers more structure in the way they communicate.

You can use Flows to generate leads, recommend products, get new sales leads, or anything else where structured communication is more natural or comfortable for your customers.

Read more about flow here.

Steps to create a Flow using Gupshup Partner APIs:

1. Create a flow
   Create Flow API allows the user to create a flow by specifying the flow's name and categories. Note the flow will be created in Draft status.
2. Now let’s add components to the Flow
   Components are the form elements in flows, how or where will you get the components from?
   • You can just generate the JSON from Meta Playground - this is an easy way as this provides a UI builder, but please keep in mind that this is not linked to WhatsApp Business Manager.
   • Build your own by using the meta documentation here.
3. Save as .json
   • Once you have your JSON code please save it with a “.json” extension. Now to attach the JSON to the pre-created flow use the Update Flow Json API.
   • If you want to preview the Flow created use the Get Preview URL API - This endpoint is used to retrieve the preview URL for a specific flow in an application.
4. Publish flow
   Publish Flow API is used to make a flow live now the status of the flow will be published.

Note: Once a Flow is Published it cannot be edited.

Now your flow is ready to send as a flow message.

How to Send Flows?

There are two ways of sending flows

1. Send flows via Session Message
   Use this API keep type parameter as individual
2. Send flows via Template Message
   Keep type parameter as Template

Note:

In both cases, you will need a flow token which you can get from WhatsApp Manager under Flows session Flow ID has to be used as Flow Token.

Below are some APIs that can come in handy when working with Flows:

Get Flow API - To retrieve detailed information about a specific flow.

Get All Flow API - To retrieve a list of all flows associated with a specific appID, the Get All Flow API is used.

Update Flow API - Used to modify an existing flow within an application by providing the app ID and flow ID.

Get Flow Json API - This endpoint is used to retrieve the JSON assets of specific app flows.

Deprecate Flow API - Used to deprecate the flow.

Delete Flow API - Used to delete a specific flow in an application by providing the app ID and flow ID. Successful deletion returns a status of "success" with a true value. - Using this API will also remove the Flow from WhatsApp Business Manager

Subscription

To manage the subscription effectively, use subscription API.

Please explicitly subscribe to Flow events to receive all the flow releated events.