Sending Messages from Hubspot

Introduction

Payemoji provides Notification APIs which can be used to trigger outbound messages to customers.   These can be implemented within Hubspot via Webhooks and used within Hubspot Workflows.  For example, when a new customer signs up and triggers the “New Customer” Hubspot Workflow the Webhook can be triggered to request Payemoji to then send a welcome WhatsApp or SMS message to the customer.

There are 3 different options to integrate to the Payemoji APIs:

Option 1 – Direct API Integration

Payemoji provides an API suite which integrates to Hubspot. Payemoji uses OAuth2 authentication which can be implemented via a Private App created within Hubspot used for verification with Hubspot Workflows.   Implementing this HTTP request may require custom code.

Documentation for these Notification APIs can be found here

Option 2 – Specified Templates

In this option, the Webhook is pointed toward an intermediary service which manage the credentials and configuration for the Payemoji APIs.   Each type of message is setup on the Payemoji side with a Template ID provided in order to send the required message.   For those using WhatsApp these would be paired with the WhatsApp template created for this purpose.  This WhatsApp template would be pre-configured within the Payemoji Template ID.

The Hubspot Webhook is configured with basic security and key value pairs set such as:

1. Mobile number

1. Name

1. Template ID to be sent

1. Other variables required in the Template (eg contract ID, payment date etc)

For example, Payemoji has configured a “New Customer” Template which has been designated as Template ID 2456.  The “New Customer” template has several variables required:

“Welcome {{name}} and thank you for joining ABC Limited!   You account ID is {{accountId}}”

The webhook would be configured similar to this (with the appropriate field references from Hubspot):

{

    "name":  "Joe",

    "accountId": "987654",

    "phoneNumber": "+3538111111",

    "templateId": "2456"

}

Option 3 – Dynamic Templates

This option works similar to Option 2 but allows our customers greater control over ongoing management of the Webhooks.  Generic Templates and their respective IDs would be provided which could then be matched with the appropriate WhatsApp template created by our customer.

For example, Payemoji could provide 3 different Template IDs to send a WhatsApp template (example IDs only):

·       WhatsApp Template Message with 1 Internal Variable              2678

·       WhatsApp Template Message with 2 Internal Variables            2679

·       WhatsApp Template Message with 3 Internal Variables            2680

The example above for “New Customer” template would be a message with 2 internal variables being {{name}} and {{accountId}} and so could send that message using Tempalte ID 2679 in the table above.  

This options allows you to create your own WhatsApp Templates in the Meta Business Manager and send these out via our dynamic webhook.

For example, ABC Limited wishes to now send an order confirmation message via WhatsApp.  They have created a WhatsApp Template called “order_confirm_WA_Template” which has the following format:

“Thank you for your recent order {{1}}!  You order has been shipped”

ABC can now use the Payemoji Template ID 2678 as it only has 1 variable it needs to send.   The format for this Webhook would look something like this:

{

    "1":  "Joe",

    "phoneNumber": "+3538111111",

    "templateId": "2678",

    "whatsappTemplate":  "order_confirm_WA_Template"

}

In this case, the variables are not named but defined by numbers instead to keep them generic (and also matches the WhatsApp Template format by numbers).  The name of the WhatsApp Template needs also to be sent to tell the Payemoji platform which one to use.   In addition, if other information is configured within the WhatsApp Template such as an image this URL would also be included as a key value pair.

Choosing the Best Method

The API integration has the most flexibility and is the fastest in terms of message delivery as it has one less than hop than those with an intermediary however this is a little more complicated and may require a developer.

Options 2 and 3 can be done by a “Power User” of Hubspot given it is relatively straightforward.   Option 2 is the simplest with Option 3 being a little more intricate but allows our Customers to be more flexible and self sufficient to send more messages.

Implementing Option 2 and 3 Via Webhooks

1. Under Method select POST
   
2. Under Webhook URL copy and paste the URL provided by Payemoji
   
3. For Authorization select API.  These details will be provide by Payemoji 
   
4. For Request Body select "Customize request body" and using the details provided by Payemoji, complete the key value pairs.   Using the example above for "Joe" you would type 1 into the first Key field and then select the "name" property from Hubspot.  For fields such as Template ID which are not from Hubspot, these are added to the Static fields in the section below
5. Click Save
   
6. You can test the Webhook within the Webhook function of the Workflow selecting a record to test with
   

 For more details using Webhooks in Hubspot click here

How Do I Get Started?

Reach out to Payemoji Support at support@payemoji.com and we will get you setup!