Gupshup WhatsApp

In uContact, you can integrate your Gupshup provider for use in your WhatsApp channels. It's very easy to set up and requires a simple configuration with the information provided by the provider.

Before you start!

Before starting the setup, you'll need certain information that uContact requires to establish the integration with the provider. Below is the necessary information.

Don't have a Gupshup account?

If you don't have a Gupshup account yet, we show you how to create one in this guide.

Gupshup Portal Configuration

Within the Gupshup portal, you need to configure certain Webhooks for the provider to function properly. You can check out this guide to learn how to do it.

• Webhook for messages and status:

https://instance.ucontactcloud.com/api/inbound/gupshupWpp/event

Replace "instance" with your instance name, without the .ucontactcloud.com. If the instance is https://marketing.ucontactcloud.com, the webhook should look like this: https://marketing.ucontactcloud.com/api/inbound/gupshupWpp/event.

Add us as a Partner!

It's important that within the Gupshup Portal you associate uContact as a partner. To do this, you can visit the following guide where we show you the step-by-step process.

Do you already have a partner number configured?

If you already have a partner number configured that is not from Net2phone, you need to contact our Support team indicating the Client Secret to be able to configure the Gupshup account associated with that partner number. Keep in mind that all Gupshup accounts used in the instance will need to be associated with that partner number.

Required Information

• Application in Gupshup: You need to have an application created in the Gupshup portal.
• API Key: API Key of the Gupshup account.
• Partner App Token: This is the Partner Token of the App that you can find within the Partners Portal.
• App ID: Unique identifier of the App.

How to configure the provider in uContact?

1. First, go to the Administration Menu and access the Connectors section. Then, within the screen, click the New button located in the upper right corner.

2. In this modal, you need to enter a unique name for the connector, select the WhatsApp channel and the Gupshup provider.

3. Then, two new sections will appear. In the Configuration section, fill in the fields with the information provided by the provider.

Configuration

• API Key: API Key of the Gupshup account.
• Partner App Token: This is the Partner Token of the App that you can find within the Partners Portal. If you have configured uContact's Partner ID in the Gupshup Self Service Portal, you should leave this field empty.
• App ID: Unique identifier of the App.
• Messages per Second: Maximum number of messages the connector can send per second.

4. Then, in the Numbers section, you need to enter the numbers you configured in the Gupshup App. Below, you can see how to add the numbers.

Numbers

• Phone List: Here you need to add the numbers the connector will use to send and receive messages. You can add them manually or in bulk using a list of numbers.

  How to add a number?

  To add a number, simply enter it in the Phone Number field and then click the + button.

  Once added, you can view it in the list.

  For each number you will have the option to:

  • Copy: this option copies the number to the clipboard.
  • Delete: this option allows you to delete the number from the connector. To delete it, you need to save the connector.

  How to upload a number list?

  To upload a number list, you need to click the button shown below.

  Then, the data import wizard will open.

  • Step 0: the required fields are displayed.
  • Step 1: you have to drag the list or select it from your computer. It must be in XLSX, ODS, CSV, or TXT format.
  • Step 2: you will see the first 3 records of the list in the left column, and in the right column you must associate it to the Phones option. Additionally, if you included a header in the list, for example, Numbers, you need to select the Contains headers option.
  • Step 3: finally, in this step you simply need to click Finish.

How to monitor the connector's status?

You can check the connector's status in real time. To do this, go to the Connectors section in the Administration Menu, where you'll see a list of all created connectors. In the Status column, the corresponding status for each connector will be displayed.

What does each status mean?

Below are the different statuses a connector can have.

The connector is functioning correctly.

The connector has stopped working and needs to be reactivated to resubscribe to the Webhook. This can be done manually or simply by clicking the Save button.

Indicates that the connector is disconnected; messages cannot be received or sent.

The connector is not currently being monitored.

HSM Templates

HSM templates are predefined messages that must be approved by WhatsApp before they can be sent. They are required to initiate interactions with customers or when more than 24 hours have passed since the customer's last message; after that time, WhatsApp does not allow free-text messages and only accepts approved templates.

Where are they created?

They are created from Meta Business or Gupshup and must go through an approval process before becoming available.

What content can they include?

Content can include text, media, header, footer, and quick reply buttons.

How to sync?

When a new Gupshup connector is created, the HSM templates from that account are imported automatically. No additional action is needed at that point.

To bring new or updated templates after creation, from the connector list click the three dots on the connector and select Sync templates.

When finished, a notification will appear indicating how many templates were added, how many were deleted, and if any could not be synced. If there were no pending changes, the notification will indicate there are no templates to sync.

Required permissions

Only users with permissions to create or edit connectors can perform template synchronization.

What gets synced?

All templates from your Gupshup account are imported, regardless of their status:

• Approved: imported in disabled state. They must be manually enabled from the campaign to be used.
• Pending / Rejected: imported in disabled state and cannot be manually enabled.

If a template with the same name already exists in the system, it will not be synced and will appear counted in the result message as "could not be synced".

Automatic updates

After the first sync, uContact receives automatic updates from Gupshup. When a template changes — either its content or approval status — uContact updates it automatically. Templates that were never manually synced are not incorporated on their own; they only appear in uContact from the next manual sync.

Linking with campaigns

• When the connector is assigned to a campaign, all its synced templates are automatically added to that campaign in disabled state. To enable them, go to the Campaign Templates section.
• When the connector is removed from a campaign, the templates are automatically removed from that campaign and cannot be used.
• If the connector is deleted, its templates are removed from the system and from all campaigns it was assigned to.
• If the connector is changed, the previous templates are removed and replaced by those of the new connector.

What's next?

Now that you know how to set up a Gupshup WhatsApp connector, let's explore how to use it in your WhatsApp channels with this tutorial!