Picky Assist Help Desk
Main WebsiteBlogFacebook Community
Picky Assist Help Desk
Picky Assist Help Desk
  • Welcome To Picky Assist 🙏
  • Setting Up Guide
    • Sending First Message
    • Connecting Channels
      • WhatsApp Web Automation to Official API Migration Guide 2024
      • Connecting WhatsApp Web Automation
      • Connecting Facebook Messenger
        • Introduction
        • Getting Start
        • Guidelines & Compliances
        • Messenger Link
      • Connecting WhatsApp Official
        • Introduction
        • Dashboard
        • Profile
        • Templates
      • Connecting WhatsApp Cloud API
      • WhatsApp Official Managed Service
      • Connecting Instagram
      • Phone Bridge (Call Blaze)
      • Connecting SMTP
      • Connecting Amazon SES
      • Connecting Sendgrid
      • Connecting Additional WhatsApp Numbers
      • Porting WhatsApp Number to Picky Assist
      • WhatsApp Official Message Delivery Issues & Solutions
    • Working With Prebuilt CRM Modules
      • Introduction
      • Onboarding
      • Modules
        • Leads
        • Deals
        • Meetings
        • Company
        • Support Cases
        • System Modules
          • Contacts
          • Notes
          • Task
          • Call Logs
          • Tags
          • Activity Logs
      • Automations
        • Workflows
        • Chatbots
        • Funnels
        • Connectors
        • Scheduler
        • Other Prebuilt Features
      • Reports and Dashboard
      • Mandatory Preconditions for Using Prebuilt
      • Testing Prebuilt
    • Managing Organization
    • Setting Up Teambox
      • Introduction
      • Routing Rules
      • Teambox
      • Inbox View
      • Organization Hierarchy
      • Analytics
    • Setting Up Smart Replies
      • Introduction
      • Train Module
        • Training Bot Introduction
        • Topics / Categories
        • Intent & Context
        • Question Variations
        • Uploading Bulk Questions
        • Reply with Media Files
        • Personalising Replies
        • Smart Actions
        • Direct URL
        • Fall Back Response
        • Small Talks
        • Testing the Bot
        • Publishing Bot
      • ChatGPT Integration
      • Learn Module
      • Stats Module
      • Deep Linking
      • Settings
    • Smart Reply V2
      • Introduction
      • ChatGPT Integration
      • Train Module
        • Training Bot Introduction
        • Topics / Categories
        • Intent & Context
        • Question Variation
        • Uploading Bulk Questions
        • Reply with Media Files
        • Personalizing Replies
        • Smart Actions
        • Direct URL
        • Fall Back Response
        • Small Talks
        • Publishing Bot
      • Learn Module
      • Stats Module
      • Deep Linking
      • Settings
    • Setting Up Broadcaster
      • Introduction
      • Creating a Campagin
      • Sending Message to WhatsApp Groups
      • Reports
      • Broadcaster V2
        • Introduction
        • Creating Campaign
        • Reports
    • Setting Up Sequence
      • Introduction
      • Creating New Sequence
      • Sequence Stats
      • Subscribe & Unsubscribe
      • Disabling Sequence Message
    • Setting Up Reminder
    • Setting Up Mobile App
    • Setting Up Connector
      • Introduction
      • Getting Started
      • Steps
        • Introduction
        • Filters
        • Delay
        • Iterator
        • Stats
      • Actions
      • Formatter
        • Date & Time
        • Counter
        • Math Calculation
        • Data Parser
        • Convert File
        • Line Items
      • Building Mini App
      • Email Parser
      • Data Storage
      • Simulate Test
      • Connector Logs
    • Email Builder
    • Setting Up Flow Builder
      • Fundamentals (Must Read)
      • Basic Terminology (Must Read)
      • Guide to Building an Effective Chatbot (Must Read)
      • Create, Manage, Test & Publish Flows
      • Triggering a Chatbot Flow
      • Steps
        • Introduction (Must Read)
        • Send Message
        • Ask A Question
        • Filter
        • Save Data
        • Actions
        • Check WhatsApp Session
        • Delay
        • Smart Delay
        • Formatter
        • Splitter
        • Data Lookup
        • Trigger HTTP API
        • Webhook
        • Apps
        • Match Keywords
        • Route to Chatbot
        • End
      • Saving Data into CRM
      • Analytics
      • Integrations
      • Flow Builder logs and conversational logs
      • Chatbot Best Practices, Ideas & FAQ
    • Setting up Modular CRM
      • Fundamentals (Must Read)
      • Guide to Building and Implementing a Modular CRM (Must Read)
      • Create & Manage Data Modules
      • CRM Macro Buttons
      • Adding Records into CRM
      • Data View & Manage Records
      • Task
      • Workflows
      • Funnels
      • Data Import
      • Integrations
    • Setting Up Scheduler
    • Media Gallery
    • Quick Replies
    • Opt-out Settings
    • Blacklist
    • Global Variables
    • Setting Up Ad-On's
      • Setting Up WhatsMail
      • Setting Up Zendesk
      • Setting Up Zapier
      • Setting Up Zoho CRM
        • Getting Started
        • Working with Extension
        • Integrating with Zoho Workflow
        • Lead Assignment Rules
        • Integrating into Custom Modules
        • Connecting Multiple WhatsApp Numbers into Zoho CRM
        • Integrating WhatsApp with Zoho CRM Mobile App
        • Keyboard Shortcuts
      • Setting Up Facebook Lead Adform
      • Facebook Lead Ad form V2
      • Setting Up WhatsApp Web
      • Setting Up Pabbly Connect
      • Setting Up ChatGPT App
    • Google Chrome Extensions
      • Extension for Sending WhatsApp Messages from any Webpage
      • Chrome Extension V2
      • Extension for Zoho CRM & Teambox
    • Managing Profile
      • Two Factor Aunthentication
      • Login History
      • Delete Account
    • Quick Rollout Guide
      • WhatsApp Official Account
    • Developers & Partners Guide for Deep Integration of Picky Assist
  • API Documentation V2
    • Introduction
    • Quick Start Guide 🏃
    • Global Webhook
      • How Webhook Works
      • Webhook Variables
      • Configuring Webhook URL
      • Webhook Request & Response
      • Getting the Conversation Context
      • Testing Your Webhook
    • Event Webhook
      • How Event Webhook Works
      • Event Webhook Variables
      • Configuring Event Webhook URL
      • Event Webhook Sample Request & Response
    • Push API
      • Introduction
      • API Variables
      • Sending Single Message - Push
      • Sending Dynamic Messages – Push
      • Sending Media Attachments – Push
      • Sending Interactive List & Buttons
      • Sending Stickers
      • Sending Bulk Messages - Push
      • Sending Contacts
      • Sending Location
      • Sending WhatsApp Template Messages
        • Introduction
        • Sending WhatsApp Template Text Messages
        • Sending WhatsApp Template Image
        • Sending WhatsApp Template Document
        • Sending WhatsApp Interactive Buttons
        • Sending WhatsApp Limited Time Offer Templates
      • Sending Message to Groups
      • Sending SMS Using SIM Card
      • Sending Message to Facebook Messenger
      • Normal Post Method
      • Delivery Reports
      • Push API Must Read Instructions
      • Testing API Requests
    • WhatsApp Template API
      • Introduction
      • API Variables
      • Template Request API
      • Template Status API
      • Languages
      • Guidelines
    • WhatsApp Group API
      • Introduction
      • API Variables
      • Create Group
      • Set Group Permission
      • Add Group Admin
      • Add Group Members
      • Fetch Group Details
      • Update Group Info
      • Remove Group Members / Admin
      • Generate New Invite Link
      • Group Delete Actions
    • WhatsApp Settings API's
      • WhatsApp Profile API
      • 2 Step Verification
      • WhatsApp Status Update
      • WhatsApp Contact & Group Fetching
    • Device Manage API’s
      • Fetching Device Status API
      • Device Commands API’s
      • WhatsApp Automation Server Status API
    • Account API
      • Fetch Balance
    • Project Management API
      • Introduction
      • Create Project
      • Get Project Details
      • Set / Update Webhook
      • Create API Token
      • Manage API Token
      • Change Billing Plan
      • Fetch Account Balance
      • Country Code & Timezones
    • References
      • Status & Error Codes
      • Most Frequent Issues & Solutions
      • Formating & Sending Emojis 😊
      • Postman Collection for Picky Assist API's
      • High Volume Messaging Bots - WhatsApp
    • Sample Codes
      • PHP
      • Python
      • Node JS
      • Ruby
      • Java
      • ASP.NET Using C#
      • Javascript
      • Go
      • Swift
      • C
      • C#
      • Objective C
  • General Guidelines
    • Billing
    • Adding Money Into Account
    • Rate Limits
    • Character Limits WhatsApp
    • Best Practices for Media Handling
    • Roadmap
    • Features In the Early Beta Version
  • Changelog
    • 2021
      • February 2021
      • March 2021
      • April 2021
      • May 2021
      • June 2021
    • 2020
      • February 2020
      • March 2020
      • April 2020
      • May 2020
      • June 2020
      • September 2020
      • October 2020
    • 2019
      • November 2019
      • October 2019
      • August 2019
      • September 2019
Powered by GitBook
On this page
  • Getting Started
  • Connector URL
  • Passing Custom Variables
  • Generate New URL
  • Map Response
  • Field Mapping
  • Mapping More Fields
  • JSON Code
  • Getting the JSON Code Structure
  • Attributes
  • Mapping Contact Owner & Channel Dynamically
  • Logs
  • Mapping JSON structure from a recent event log
  • Viewing Execution Log
  • Stats
  • Versions

Was this helpful?

  1. Setting Up Guide
  2. Setting Up Connector

Getting Started

Connector Configuration Help File

PreviousIntroductionNextSteps

Last updated 8 months ago

Was this helpful?

Getting Started

From the Left Side More Menu -> Automation -> 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.

Connector URL

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.

Passing Custom Variables

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

Generate New URL

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

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,

Field Mapping

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.

Mapping More Fields

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.

JSON Code

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

Getting the JSON Code Structure

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

Don't proceed with further steps until you have a JSON Code Updated.

Attributes

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

Mapping Contact Owner & Channel Dynamically

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

Logs

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

  1. Remap the JSON with the log by clicking the "Map" button

  2. See the event execution log which helps you understand what all actions the connector took based on the event received

Mapping JSON structure from a recent event log

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

Viewing Execution Log

You can see the execution steps of each event received from 3rd party as shown below;

Stats

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.

Versions

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

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 and we will convert this as JSON for ease of processing.

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 pages

https://connecting.url/?name=yourvalue&mobile=yourvalue&email=yourvalue
Channels
Connectors