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
  • Few use case are as below;
  • Setting Up HTTP API
  • Testing the API
  • Mapping Response
  • Logs
  • Fallback
  • Rate Limit & Timeout

Was this helpful?

  1. Setting Up Guide
  2. Setting Up Flow Builder
  3. Steps

Trigger HTTP API

PreviousData LookupNextWebhook

Last updated 1 year ago

Was this helpful?

The trigger HTTP API step is a favorite among developers as it allows you to trigger an external API directly within the flow. This step is particularly useful for passing data collected by the bot to third-party platforms or fetching information from a third-party platform and providing it back to the user. By integrating with other platforms, the chatbot becomes more personalized and relevant to your users, especially if you use other platforms to manage your business operations.

With the trigger HTTP API step, you can seamlessly exchange data between your chatbot and external systems, enabling a more dynamic and interactive conversational experience for your users.

You don't need to be a developer or possess any coding skills to use the HTTP API provided by a third-party platform. However, you do need to spend some time understanding how APIs work. After that, you can simply copy and paste certain details from the API documentation to our platform.

Few use case are as below;

  1. Pass the data collected by the bot to a 3rd party CRM or application

  2. Fetch the order details and reply back to the user

  3. Fetch the customer details from a 3rd party application and progress the flow as per the dynamic data received

Setting Up HTTP API

Click on Settings and it will open a popup as shown below where you can construct the API

Name : You can give a name for the request you make like Contact Adding API

Method : We support all the request method like POST, GET, DELETE,PUT,PATCH,HEAD etc as per the API doc's you need to select the correct method

URL : This is where you need to put the API endpoint, on clicking the </> icon you can dynamically select attributes

Header : This is where you can pass the header contents, the key is the variable name and value is the value, this is applicable if the 3rd party API doc specific that certain values needs to be passed as header, can click on "Add Header" button to add more headers

Body : This is where you can pass the body of the request, this is optional and based on each API doc you can pass the body, the body can be passed in various methods like Query String, JSON, Row - if you select row you will able to pass any kind of contents or codes

Can use the attribute, body type, and row content as shown below

Testing the API

After you selected the Request Method, URL, Header & Body (if applicable) you need to trigger "Test" button to make a test API call to the 3rd party as show below

Mapping Response

We support response mapping in JSON format only, i.e your API provider must give a response in JSON format and the response values will be available in the attribute section and can be used in further steps.

For example, if you want to lookup whether a contact is existing in your CRM or not then you may need the response mapping coming from your CRM, in the further steps you can make use of the values.

Important Notes

  1. If the response is not in JSON format then we will show an error "Response Mapping Not Done, Only JSON can be mapped as Response "

  2. If the response is in JSON format then the system will automatically map the JSON values and will be available to select in further steps.

  3. The response will automatically map only for the first time, if there is a change in the JSON structure then the system will prompt you with the message "JSON Structure Change Detected" and will give you an option to remap the Structure.

Logs

Logs menu will show only after triggering at-least one API request, only last 20 logs will be shown, you can click the "View" button to see the detailed request and response.

Fallback

Fallback is the feature used to instruct our system what action should be taken if your API request is failed, you can choose "Continue Further Steps" or "Stop Executing Further Steps" depends on further steps settings you can choose the fall back action.

Alert Email : Alert email helps you to get email alerts whenever an API request is failed, you can sepcificy upto 10 email address separated by comma.

In order to avoid sending too many email, our system will send only 1 email in every one hour irrespective of number of API requests are getting failed. if you want to test this or reset the counter then click on "Reset Mail Timeout" this will clear the counter.

Rate Limit & Timeout

  1. Maximum timeout for API response is configured to 1 minute i.e if we are not getting any response from the 3rd party API in 60 seconds the system will terminate the API request.

  2. Please use the HTTP API feature keeping the Rate Limit in mind, by default all accounts have a API rate limit of 10 requests per minute, if you need to increase this limit please contact support@pickyassist.com if you are making more than 10 API requests in a minute you will get an error "Rate Limit Exceeded"