Introduction WhatsApp Cloud API module for Perfex CRM

Thank you for purchasing WhatsApp Cloud API module for Perfex CRM.

The WhatsApp Business Platform Intergration module for Perfex CRM, gives medium to large businesses the ability to connect with customers at scale, using Cloud API and free messaging, under WhatsApp Business Account (WABA) limits.

You can start conversations with customers, send customer notifications or infromation regarding actions that occur in your Perfex CRM.

Features

Current version's supported actions list

- Broadcast (custom) messages. You can send your custom messages and their content can include a dynamic (merge) field.

- Available notifications for Leads (new lead creation):
1) WhatsApp notification to the lead's phone number through a template that supports merge fields.

- Available notifications for Contacts (new contact creation):
1) WhatsApp notification to the contact's phone number through a template that supports merge fields.

- Available notifications for Invoices (new invoice creation):
1) WhatsApp notification to the phone number of the primary contact of the related Customer, through a template that supports merge fields.
2) WhatsApp notification to the phone number of each Staff member, through a template that supports merge fields.

- Available notifications for Tasks (new project's task creation):
1) WhatsApp notification to the phone number of the primary contact of the related Customer, through a template that supports merge fields.
2) WhatsApp notification to the phone number of each Staff member, through a template that supports merge fields.

- Available notifications for Projects (new project creation):
1) WhatsApp notification to the phone number of the primary contact of the related Customer, through a template that supports merge fields.
2) WhatsApp notification to the phone number of each Staff member, through a template that supports merge fields.

- Available notifications for Proposals (new proposal creation):
1) WhatsApp notification to the phone number of the primary contact of the related Proposal, through a template that supports merge fields.
2) WhatsApp notification to the phone number of each Staff member, through a template that supports merge fields.

Dependencies

You need to own a Facebook Developers Account.
Not sure how to create one? Check out the videocast at the Configuration section.

You need to create Facebook App through a Facebook Verified (or unverified) Business / Individual account.
Not sure how to create one? Check out the videocast at the Configuration section.

You can skip verification of your Facebook Business used for sending messages, but in this case, you will be limited to WhatsApp Messaging limits.
Learn how to increase this limit here.

Keep in mind that the Primary contact of the Customer will be used for receiving the above WhatsApp notifications, in case a valid mobile phone number with country code exists in the contact.
- Broadcast messages can include up to one dynamic (merge) field.

Installation

It takes only a few seconds to be installed and activated. Follow the steps below, in order to ensure that you will go smooth through installing/activating process.

If you have any questions, feel free to raise a support ticket at our Support Area.
Guys from support department will get back to you as soon as possible with a reply.

Installation Steps

Extract your downloaded file contens. You will notice a folder called "documentation" and a new zip file, called "upload.zip". Since "documentation" folder contains this readme file and helpful instructions that are not needed in your Perfex CRM's installation, we will focus on the "upload.zip" file.

"upload.zip" contains the module files (in a module format) that you upload in Perfex CRM's Modules installation section.

Go to your Perfex CRM's Admin area and select the following menu item: SETUP > MODULES.

Select the extracted upload.zip at Module installation selection prompt and press INSTALL.

Find the newly installed module and press ACTIVATE.

You will be told that module is successfully activated.

That's it!

You will be told that module is successfully activated, after entering your License Key.

Configuration

Our team provides videocast recorded sessions for every single step of the configuration process.
Please ensure that you follow each step of the videocast. If you have any questions, feel free to raise a support ticket at our Support Area

Facebook Developers Account

How to sign up for a Facebook Developers Account

1. Login to your Facebook account and navigate to Developers Section
Click on Get Started button from top right corner.

2. Click on next button from the popup

3. Enter your phone number and verify your account using text message or phone call.

4. It may be needed to verify your account again.

5. Then enter verification code you got and click on the Verify button.

6. On the next screen, after verifying your account, 3rd step is to tell about you. Select Developer option here and no further steps will be required.

Facebook Application Creation

Please follow the steps of the videocasts below, so you can create a Facebook Application needed for sending our WhatsApp messages through your Perfex CRM

How to create a Facebook Application for WhatsApp Cloud API module:

Now that you are done with the Application Creation, you need to create a Permanent Access Token.
This video, demonstrates the way to do so:

Facebook provides a written guide regarding the process of creating an Application for WhatsApp messages here, in case you find it useful.

Module's Settings

You only need to fill three settings in order to have our module in working state.

Navigate to Settings > WhatsApp menu link of the Perfex CRM's backend (Admin Area) and fill the necessary values in the respective fields.
All needed values can be obtained from your Application creation and Permanent Token creation processes, as described in the Facebook Application Creation steps above.

Templates Creation

Our module supports creation of multilingual messaging templates.

Here's a videocast on how to create multilingual message templates:

Templates & Merge fields Mapping

Our module supports template mapping & merge fields for messages.

Here's a videocast on how to create template mappings, use merge fields and test a sample notification:

Logging

Our module supports logging of all operations (messages sent).

You can access the Logging area along with its entries, through this menu link:

Debugging

Our module supports debugging of log entries, in cases that troubleshooting is needed.

You can access the Debugging area of each log entry, through the logs area, by clicking this icon at the respective entry you want to have its debug data inspected:

Actions breakdown

Detailed actions of the current verison, including parameters, requirements & expected behaviors.

Customer-received Available Actions List

Controller	Required fields	Description	Extra requirement(s)
Invoice	Customer	When a customer is selected, module will automatically send a message to the primary contact of the selected customer.	Number, in country code format, is required
		Merge Fields : Available by selecting from the staff fields in template mapping screen (details of Invoice's sales agent)
Task	Related to : Project	A message will be sent to primary contact of the customer, of the Project	Number, in country code format, is required
		Merge Fields : Available by selecting from the staff fields in template mapping screen (details of first assignee of the Task)
Project	Customer	When a customer is selected, module will automatically send a message to the primary contact of the selected customer.	Number, in country code format, is required
		Merge Fields : Available by selecting from the staff fields in template mapping screen (details of first member of the Project)
Proposal	Related to : Customer	When a customer is selected, module will automatically send a message to the primary contact of the selected customer.	Number, in country code format, is required
		Merge Fields : Available by selecting from the staff fields in template mapping screen (details of assigned user of the Proposal)

Staff-received Available Actions List

Controller	Required fields	Description	Extra requirement(s)
Leads	Phone	A message will be sent to the Assigned Staff member	Number, in country code format, is required
Contact	Phone	Upon new contact creation, a created message will be sent to the primary Customer's contact	Number, in country code format, is required
Invoice	Customer	Once a sales agent is selected, a message will be sent to him (staff)	Number, in country code format, is required
		Merge Fields : Available by selecting from the staff fields in template mapping screen (details of Invoice's Customer)
Task	Related to : Project	A message will be sent to first Staff member assigned in the Task	Number, in country code format, is required
		Merge Fields : Available by selecting from the staff fields in template mapping screen (details of Project's Customer)
Project	Customer	A message will be sent to first Staff member assigned in the Project	Number, in country code format, is required
		Merge Fields : Available by selecting from the staff fields in template mapping screen (details of Project's Customer)
Proposal	Related to : Customer	A message will be sent to selected Staff member	Number, in country code format, is required
		Merge Fields : Available by selecting from the staff fields in template mapping screen (details of Proposal's Customer)