Getting Started
Connector Configuration Help File
Last updated
Connector Configuration Help File
Last updated
From the Left Side More Menu -> Automation -> Connectors and the first step is to create a connector URL, to do this from the top left side click on the “Add” button.
In the popup fill the details :- Give the Connector Name and Description (Optional) and select the required event source from the Event Source drop down in the respective fields and click the “Save” Button.
See the below picture:
Event source
The Event Source ensures that your connector responds to the correct triggers and integrates seamlessly with further requirements. Depending on the selected Event Source, logs are generated to provide the necessary data for mapping attributes, allowing you to perform actions and achieve smooth operation within your connector.
The types of Event Sources include:
Webhook : For events triggered by webhooks from 3rd party apps.
Email : For events initiated by Incoming emails.
Mini App : For events from a mini app.
Reminder : For events generated by reminders.
Broadcaster Followup : For follow-up actions from the Broadcaster V2.
Broadcaster Track : For tracking buttons and URLs within the Broadcaster V2.
Smart Reply ChatGPT : For events triggered by Smart Reply powered by ChatGPT.
Task : For events associated with tasks.
Call Blaze : For events related to Call Blaze.
CRM Macro Buttons : For events from CRM Macro Buttons.
This is the unique URL generated for the connector you created, this needs to be configured/added into the 3rd party software/application from which you wish to receive an event to the Picky Assist.
Generally, 3rd Party App call it as below;
Webhooks (Mostly Everywhere)
Rest Hooks
Hooks
Call Back URL
HTTP Request
Just check and confirm whether your software supports sending data to 3rd party software through webhooks when an event happens in the software.
It's possible to pass custom variables in the query string method along with the URL apart from the body in JSON i.e you can pass https://url.com/app/349384934?value1=1&value2=2
The values passed through the query string method will be available as "custom_variables" in JSON code and further you can make use of these values in the Steps, refer to the below image to understand where the custom variables are visible
Common Usecase of Custom Variables Custom variables are useful in situations where your application doesn't allow you to pass a custom JSON payload but you want to use the single connecting URL for sending multiple messages for example you have a flow where you need to send different messages to a user at different situations as below; Day 1 -> Message 1 Day 2 -> Message 2 Day 3 -> Message 3 Without the custom variable, you need to create 3 Connector URLs and configure 3 Actions separately and this process may be hefty if you have a high number of automation, so using the custom variable and filter you can achieve this within a single connector.
First, pass the variable as value=day1 for the first automation than for the second message pass value=day2 and for the 3rd-day pass value=day3 then create a filter in the Steps for day1 and define the message that needs to be sent for the day1 similarly you can do this for all the days
Please make sure the variable remains the same for all requests
Please keep this URL private and in case if you feel the URL is comprised, click the “Generate New URL” and this will generate a new connector URL, please note after generating the new URL please make sure it's updated in the app/software from which the URL is getting triggered.
Map response helps you to send a response back to the app/software, for example certain applications need a response from the URL and in this case, you must setup the same in order for the webhook to be configured in their system
On clicking "Map Response" a popup will open where you can give a static response in plain text, HTML, or any other code as needed,
This helps you to map the incoming data variables to the Picky Assist Attributes which helps you to create a new contact in Picky Assist or sync the data from the 3rd party platform to Picky Assist Attribute values when an event happens in the 3rd party Apps
The usage is like when a new lead is created in your platform add them into Picky Assist so that you will be able to make use of the WhatsApp Drip Campaign, Broadcaster feature through Picky Assist in just a few clicks.
You can map more fields by clicking the "Add More" button and then clicking the box which opens a new popup to select the field to be mapped
Please note in order to map a field it’s mandatory to map the mobile number or email and default channel first. Every time the event is triggered the mapped data fields will get updated against each subscriber in the Picky Assist There is a situation that your 3rd party platform doesn't have the mobile number of the customer stored but you have the mobile number and email of the customer stored in the Picky Assist Platform, in this case, it's possible to find the mobile number using the email address coming from the 3rd party site and able to send WhatsApp messages or take different actions with Picky Assist
Please note if multiple email addresses are saved in the Contacts in the Picky Assist then we will consider the contact which is added first into the consideration.
This is the core of the platform which helps our system to identify the data structure i.e in which variables the data is available for us to process, we support only JSON and Query String Methods
Mostly 99.9% of Webhooks are in JSON Format so it's a widely used format, however if you want to simply POST/GET a Query String then you can pass the data along with the Connecting URL as https://connecting.url/?name=yourvalue&mobile=yourvalue&email=yourvalue and we will convert this as JSON for ease of processing.
By default this code is empty until we receive the first event from the 3rd party platform, when we receive the event we automatically Map this and further the data structure will be available in the connector to reuse or configure.
Once the Connector URL is set as Webhook / Hook / HTTP Request in the 3rd party software/application please trigger the event so that our system received the payload and maps the structure.
You will able to see the event trigger logs from the right-hand side as shown below, clicking on the even will open a popup and you will able to see the JSON Code Structure in the body
A pop up will open with the structure of the data, you can view the data in 2 ways i.e Design & Code
If you are a developer and know the structure of the which is likely to send from the 3rd party applications then you can click on the "Code" tab and update the code manually as well, we don't recommend this method
Attributes play an important role in Filters & Actions like Sending Messages, Email etc, attributes helps to personalize the contents of an email or message.
Wherever in the connector, you see </> this means an attribute or value available for dynamic mapping so simply click on it and a popup will open the screen
There are 3 types of attributes available in the connector as below;
Event Attributes: This is the attributes from the 3rd party Software / Application and will be available to select wherever you see </> symbol
System Attributes: This is the Picky Assist default attributes i.e Name, Email, Mobile , Time Zone, Current Time
Subscriber Attributes: This is the Picky Assist Social CRM Attributes created by you. Formatter: All the data stored in the formatter will be displayed under the formatter attribute section
There will be a situation where your system decides dynamically from which channel you would like to send a message if you have more than one WhatsApp or Email channel connected to your Picky Assist account, in this case, you may simply use the dynamic channel mapping by just passing the Channel Unique id of each channel to the connector, you can get the channel unique id from your Channels pages
Dynamic contact mapping helps you to assign a chat or change the contact owner as per the logic in your system for example you need to assign a chat to a specific agent in your Teambox when an event happens, rather than creating many filters in the connector using the dynamic mapping feature your can simply pass the agent email address to the connector and based on that value connector will select the contact
You will see below option wherever in the connector which support dynamic mapping feature
On clicking the dynamic mapping option you will see an option to select the attribute as below
All events triggered from the 3rd party software will be available in the logs and this helps to troubleshoot any issues in your workflow, you can do the following actions from a log entry
Remap the JSON with the log by clicking the "Map" button
See the event execution log which helps you understand what all actions the connector took based on the event received
Kindly note once you remapped the JSON if the structure is different hen you must adjust your workflow accordingly to ensure that they will work as it should be, so perform this action very carefully if you have many steps in your connector
You can see the execution steps of each event received from 3rd party as shown below;
You can see the number of events received from the 3rd party in the right side of each Connector as shown below;
The stats show the lifetime value however if you want to reset the stats then you can reset the stats by clicking the "Reset" option as shown in the above image.
Once you reset the stats it will show the stats only after the reset date.
The version helps you to restore the last saved version in case the configuration have any issues, you can see the last 20 version history and able to restore it.
Use the version restore feature carefully if the JSON structure got changed and you restored to a previous version then it may not work as it should be until it mapped the fields properly, so after the version history restore please test your configuration thoroughly
