Getting Started
Connector Configuration Help File
The first step is to create a connector url, to do this from the top left side click on “Add” and in the popup fill the details
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;
- 1.Webhooks (Mostly Everywhere)
- 2.Rest Hooks
- 3.Hooks
- 4.Call Back URL
- 5.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 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 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 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 don't allow to pass a custom JSON payload but you want to use the single connecting URL for sending multiple messages for an 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 URL and configure 3 Actions separately and this process may be hefty if you have high number of automations, 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 then for second message pass value=day2 and for 3rd day pass value=day3 then create a filter in the Steps for day1 and define the message needs to be send for the day1 similarly you can do this for all the days
Please make sure the variable remains 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, if your application needs to perform certain actions based on the response then you can customise the response in any format and include the attributes from the Picky Assist Platform or even from the inbound received payload.
On clicking "Map Response" a popup will open where you can place response in plan text, html or any other code's as needed, you can also use the "Attributes" to insert the values from the Connector
This helps you to map the incoming data variables to the Picky Assist Attributes which helps you to create a new subscriber 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 click 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 update against each subscriber in the Picky Assist
There is a situation that your 3rd party platform don'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 address are saved in the Contacts/Subscribers in the Picky Assist then we will consider the contact which is added first into the Contacts/Subscribers.
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 Method
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 map 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 popup 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 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
Steps help you to take different actions based on different conditions, you can create upto 50 Steps with different filter conditions, delay and actions to automate many tedious tasks.
If you want to send birthday greetings in 5 languages based on the customer country or language settings then you can do this using Multiple Steps, you can create 5 steps and each step will have a filter to check the customer language and have action to send message in different languages.
A step have 4 components Filter, Delay, Action & Stats as shown below;
When an event enters into a step it start executing the components as per the order it saves, you can drag and change the components order the way
You can change the components in the step easily by drag and move so you will have the flexibility to execute the delay first then check for filter and take actions, or you can first take action then filter some data and delay further steps
In order to easily identify what action it performs you can name it by clicking the “Step Name” and entering the Name.
On clicking the delete button will delete all actions and filters associated with a step
You can add more steps to perform complex filters, actions and delay as per your business requirements
The step will be executed in the order how it's saved and displayed, you can change the order by click and drag it
You can easily clone and existing step by click the icon as shown below and this helps you to save your time building the filter and action again from the scratch, instead you can simply clone any steps and make necessary changes to the cloned step
Filter is one of the most powerful feature which helps you to filter the data coming from another app or the data stored within the picky assist and perform Actions based on the filter matching conditions,
For example, if the age of the person is between 18-25 and gender is male then perform a set of action defined by you, similarly you can create any number of filters and specify actions which are specified to the filters
You can create Unlimited AND filter conditions and decide whether to match all conditions or match any conditions to perform the action in the step.
Match All Conditions : If you select this then the system will match all conditions configured in the filter i.e all conditions should be true to take further actions
Match Any Condition : If "Match Any Condition" is selected then the system will proceed to the next step if any of the condition in the filter becomes true.
Please note if the filter condition is false then it will skip the action configured in the step and moves into the next step in the order, so if you want to perform separate action for both filter conditions i.e true and false then please create another step with the false condition just below the true condition step
Below are the available data types and conditions to filter
Data Types | Condition |
Text | is isn't contains doesn't contains starts with ends with minimum length maximum length is empty is not empty |
Numeric | equals not equals greater than less than between not between minimum length maximum length is empty is not empty |
Date & Time | is isn’t on after before not before between not between is empty is not empty |
Date | is isn’t on after before not before between not between is empty is not empty |
Time | is isn’t on after before not before between not between is empty is not empty |
Email | is isn't contains doesn't contains starts with ends with is empty is not empty |
Website | is isn't contains doesn't contains starts with ends with is empty is not empty |
URL | is isn't contains doesn't contains starts with ends with is empty is not empty |
Choice | is isn't is empty is not empty |
WhatsApp
to Filter WhatsApp numbers | is isn't |
There will be a situation when working with many 3rd parties that the date and time may not always be in ISO Standards so we have a date & time formatter which helps you to map the Day, Month, Year, Time, Hour, Format virtually from any type of formats when separated a record with a comma, hyphen, slash, dot, semi column
You will also have the option to convert a date and time from a timezone to another which helps to send messages at the right time.
Date & Time formatter will appear when any of the Filter field type is Date, Date or Time, Time as show below
Delay helps to pause the execution of the steps for a certain period, there are many handy usecases for this feature's few are as below;
- 1.Sending an Automatic Followup After X days from the Lead Creation Date
- 2.Sending Periodic Reminders for Webinars like before 2 days, before 5 hours, before 30 minutes, on the specific date, after 1 day etc
- 3.Sending Payment Reminders / Due alerts which respects to certain dates
- 4.Sending a Meeting Reminders from Google Calendar, Outlook, Calendly etc
- 5.Sending a Feedback Message form after X hours from the product delivery time
After ___ minutes /hours/day from last executed Step date
After ___ minutes / hours / day from Event Received Date
Custom Delay
Before ___ minutes /hours/day from a Specified date
After ___ minutes /hours/day from Specified date
On ___ a Specified date
Custom delay gives you the power to set a delay based on a specific date in a dynamic way, for an example you can minimise the no show for your Zoom Webinar using the Custom Delay which can send an automatic reminders before, after and on the Webinar Start Date
Please note if you are not mentioning a date then the delay will execute at 12 am in your Timezone which is configured in your profile, to avoid delivering any messages in 12 am or Odd timings you can add 10 hours after the date so it will deliver messages at 10 am i.e `10 hours from 12 am
Currently we support only ISO Standard Date & Time & Timestamp, mostly all 3rd party providers sends the date and time in ISO Standard format.
Identifier in the delay helps to track the delays which are in the queue to be executed in a future date, you can give a unique name or dynamically set the identifier name based on the event data from the 3rd party like Webinar Name, Webinar Unique ID etc as shown below;
Major usecase of the identifier is to cancel the queue in case something is not right or let's say a Webinar Event is cancelled and you want to stop sending the reminders of that particular webinar.
You can see how many executions are in the queue which will be processed in the future date and time
Clicking on this button it opens a popup which contains the Identifier Name & Step which helps you to easily track the identifier which needs to be cancelled as shown below
Clicking on this button it opens a popup which contains the Identifier Name & Step which helps you to easily track the identifier which needs to be cancelled as shown below;
If the delay date validation is failed or the date/time is passed the current date/time then you can specify what action to be taken further as below;
1) Stop Executing Further Steps
2) Continue Executing Further Steps
Using the filters in the popup you able to filter out all unique identifiers by its name for an example Webinar Name, Webinar ID, you can select one or multiple identifier which need to be cancelled
Another popup will open which shows all count of the unique identifier, you can select one or multiple
There would be a situation that you want to cancel all delays in all the steps you have, this can be done using the Steps in the popup as shown below;
When you cancel a delay it prompt to ask the action which needs to be taken, here you have the option to select 3 actions
1) Stop Executing Further Steps
2) Continue Executing Further Steps
3) Execute As Per Delay Fallback Configuration - This means this will respect the fall back delay you configured while created the identifier
Actions help you to take 15+ actions like Sending A WhatsApp Message, Email, Add Tag, Adding into Subscribers, Adding User Into a Sequence etc
You can add multiple actions into a single step which will execute in the order as it displayed on the screen, you can change the action execute order by dragging each actions as shown below;
Action Category | Action | Description |
Notification | Send Message | Send WhatsApp Message |
| Send Email | Send An Email |
| Broadcaster | Send WhatsApp Message to a Group of Users, option to segment as well |
Counter | Trigger Counter | Setting the Counter Value by a number specified |
| Reset Counter | Resetting the Counter existing value to its default value |
WhatsApp Group | Send Message to WA Groups | Post a WhatsApp message into one or more groups |
| Add User Into WA Groups | Add Members or Admin into one ore more groups |
| Remove user from a WA Group | Remove a users from a WhatsApp Group |
| Create a WA Group | This will automatically create a new WhatsApp Group |
Attributes | Set Attribute | Set an Attribute Value of the Subscriber Field in the Social CRM |
| Clear Attribute | Clear the value saved against the field |
CRM | Add Tag | A New tag will be added |
| Remove Tag | A specific tag can be removed |
| Add Category | A contact can be added into one ore more categories |
| Remove From Category | A contact can be removed from the category |
| Open Ticket | Create A new Ticket in the Social CRM |
Automation | Add to Sequence | Add a contact into a Sequence |
| Remove From Sequence | Remove a contact from a Sequence |
| Pause Smart Replies | Pause the smart replies for X time |
| Blacklist Number | Blacklist the Contact |
| Remove From Blacklist | Remove the number from blacklist |
| Stop Executing Further Steps | This will stop executing all further steps. |
Attributes plays an important role in Filters & Actions like Sending Messages, Email etc , attributes helps to personalize the contents in an email or message. 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 into the formatter will be displayed under the formatter attribute section
All events triggered from the 3rd party software will be available in the logs and this helps to troubleshoot the issue or copy the JSON code from the body
You can see the number of events received from the 3rd party in the right side of each Connector as show below;
The stats shows 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 shows the stats only after the reset date.
Version helps you to restore a last saved version in case if the configuration have any issues, you can see 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
Last modified 1yr ago