Quick Start Guide 🏃

Watch the Quick Video Intro

Quick Setup

Generate API Token -> Select Your Project -> Settings -> Developers -> API - API V4

Setup Webhook -> Select Project - Settings -> Developers -> Webhook - V4 Webhook

Webhook & API support only POST method & both make use of JSON format, no header-based authentication required, and pass the API token token variable in the body.

Generating API Token in V4

1

Log in to the Admin Account of Picky Assist

Navigate to More Menu -> Developers

2

Click the "Create API Token" button as shown below

Click the button to generate the token

3

Enter Token Name for reference

To enhance security, enter a token name and, optionally, an IP address to restrict API request authentication to that specific IP (recommended).

4

Store Your API Key Securely

Once generated, the API Key will not be visible on our platform. Please store it securely.

We have a common structure for all supported channels so please go through the API documentation carefully to make use of the correct variables and values.

Receiving Messages

Webhook is responsible to handle the incoming messages to your application. When a new message arrives in the channel connected by you then the message details will be pushed to your web server instantly.

1. 👉message-in this variable holds the message contents and this is URL encoded, so you need to decode the same. You can also get the raw i.e URL not coded value from message-in-raw variable

2. 👉 We use the POST method to push messages to your server and the payload format is JSON.

Instant Reply - if you would like to give an instant reply back to the user whenever you receive an incoming message then give your reply message in JSON format as a response to the webhook (like giving acknowledgment ) This method is highly recommended for all those who want to give an instant reply back without calling another Push API

Sending Messages (PUSH API)

In order to send messages out, you need to make use of the PUSH API. Use our postman collection for quick testing. Get Postman Collection

1. The recipient's mobile number must be passed with the country code without 0 or +

2. Supports only the POST method and the payload format should be in JSON

3. Make use of dynamic API to send personalized messages in a single API call rather than calling API multiple times (rates limits are applicable)

4. If you would like to send media files then please upload your media to a public URL and pass the link to download through media-url variable. Please note the URL should not redirect to another page/server.

Using WhatsApp Official & Cloud API Account

1. For WhatsApp Official & Cloud API make sure you have a valid session to the recipient's mobile number before sending a message, if there is no valid session then you need to make use of approved template messages

2. WhatsApp Official & Cloud API new numbers must go through a warm-up process i.e by default all new numbers are allowed to send messages only to 1000 users in 24 hours window this will gradually increase when you send messages to more users. This is not applicable to WhatsApp session messages. Read More

3. For Facebook messenger, you need to make use of the subscriber's unique id to send a message.

Sending Templated Messages to WhatsApp

Templated messages are used only to send messages if no valid session is available against a recipient's mobile number. Read More

API Rate Limit

All the API requests to any endpoints are rate limited to 90 requests per minute from one project, if we are getting more than 90 requests per minute then you will receive an error "429" and those messages or requests will be dropped in our firewall level and won't be showing in your Picky Assist Platform

If you want to send high-volume personalized messaging then we highly recommend making use of our Dynamic Push API. Read More

The Admin will also receive an email notification with the Subject "Urgent Rate Limit Reached - Picky Assist" whenever we throttle your request because of the rate limit. Kindly note that in order to avoid cluttering your email inbox we will send emails once in every 30 minutes only even if we drop your message continuously.