ReplyCX Documentation
Login
  • ⛩️Welcome to ReplyCX Knowledge Base! 📚
    • ReplyCX Basics
  • ▶️GETTING STARTED
    • Building a Chatbot
    • Testing a Chatbot
    • Channel Configurations
    • Deploying a Chatbot
    • Utility Tools
  • 🧩ACTION BLOCKS
    • Overview
    • Trigger
    • Send Message
    • Collect Input
    • Buttons
    • Carousel
    • Calendar
    • Send an Email
    • Condition
    • Image Carousel
    • Human Handover
    • Slider
    • Collect File
    • Delay
    • Form
    • Flow
    • Code-block
    • Options
    • Jump
    • List
    • Reply Button
    • AI Model
    • SET AI
    • Answer AI
    • AI AGENT
    • Webhook
    • Javascript
    • Send Status
    • Http Request
    • Dynamic data
    • Whatsapp flow
  • 🦾AI Studio
    • Building a GPT Chatbot
    • Knowledge Base
    • Training on historical live chat to generate response
    • Retrain frequency for URL data source
    • Custom Answers
    • Function Call
    • Prompts
    • Tokens
    • Setting up retrain
    • Advanced Crawling Criteria
  • ⛓️Integrations
    • Types of Integrations
    • Service Call
    • Google Sheets
      • Support for “Update Record” in Google Sheets
    • Codeblock
    • Google Calendar
    • Calendly
    • Zoho CRM
    • Hubspot
    • Dialog Flow
    • Events
    • Google Analytics
    • Freshdesk
    • Salesforce
    • Zapier
    • Airtable
    • Public API's
  • 🟢WhatsApp Business API
    • Prerequisites
    • WhatsApp Business API - Meta
    • Using a test WhatsApp Business API account
    • Product catalog on WhatsApp
    • Sync WhatsApp Template
    • Support for Carousel template message
  • Instagram
    • Using the Instagram Channel
  • 💬Live Chat
    • Overview
    • Saved Replies
    • Manage Saved Replies
    • Message status on live chat
    • Generating Response Using AI.
    • Rewriting existing response with AI
    • Labels
    • Managing Labels
    • Qualification details covered during a conversation
    • Settings
    • Filter conversations
    • Conversation History
    • Close a conversation
    • Related / Past Conversations
    • Elements on conversation card
    • Kind of Conversation Status
    • Copy Chat Transcript of a Conversation
    • Customize Live Chat Screen
    • Restart Conversation
    • Blocking Contacts
    • Agent status on live chat
  • ⚙️Troubleshooting
    • Variable Manager
    • Fallback Variables
    • Human Handover Configuration
    • Clone a bot
    • Preffered Image Dimensions
    • Working of Link Tracking
    • Setting up variables using trigger block
    • Availability of agents in Human Handover
    • Creating loop in the conversational flow
    • Requesting Edit Access
    • Cookies
  • 📢Outbound Bots
    • Outbound Action Blocks
      • Delay
      • Send WhatsApp
      • Send SMS
      • Send Email
    • Building a One-Off Campaign
    • Building a Ongoing Campaign
    • Creating WhatsApp Templates
  • 📱Chat Widget Customization
    • Embedding Chat Widgets
    • Customize Chat Widget UI using CSS
    • Display Chat Widget in iFrame
    • Change Appearance
    • Chat widget 3.0
  • 🏦Account Management
    • Manage Teams
    • Manage Teammates
    • Manage Roles
      • Channel configuration Permission
    • Opt Out Management
  • 📊Reporting
    • Custom Reports
    • Contacts Feature Recap
    • Scheduling Contact Report
    • Weekly Reports and Interactions
    • Export a contact list
    • Tracking link clicks on chatbot messages
    • Agent Report
    • AI Agent Report
    • Outbound Report
  • 🧑‍💻 Support
    • Forget Password
Powered by GitBook
On this page
  • Testing the Integration:
  • Storing the Responses:

Was this helpful?

  1. Integrations

Service Call

PreviousTypes of IntegrationsNextGoogle Sheets

Last updated 11 months ago

Was this helpful?

REST APIs are used to Push / Pull data to / from third party systems. Using the Service Call action block, you can directly integrate a third-party system's REST API in a flow.

You can integrate GET, POST or PUT type REST API through Service Call action block from the Bot Builder page.

Here are the steps that you can follow to configure the same:

  1. Add the ‘Service Call’ action block.

  2. Configure your API on the right panel. To configure your API on the Service Call action block, below are the fields that you would be filling values in. If you are a developer, you would feel at home here, for others, you may need to refer to the APIs documentation to find what to fill on the right panel.

  3. Types of Methods: You will first need to select the 'Type of Method' from the drop-down list from the available options. Reply CX currently supports three types of methods, they are:

    • GET

    • POST

    • PUT

  4. Endpoint URL: You will need to provide the absolute URL i.e., starting with HTTP or HTTPS. You can also use the variables in the URL by typing '#' as some of the APIs do not have headers and everything is mentioned in the URL itself.

    For example: https://api.weatherapi.com/v1/current.json?
    key=e943b863ebed4572b55140350200312&q=#city#city#.
    
    In the above link, #city# is the variable that has been used.

    1. Headers: 'Request Headers' allows you to authenticate the API based on its tokens. You can also use variables as tokens too by typing '#'. You need to ensure that you add following token in the header:

    2. Body: Under ‘Request Body’ you can define what information needs to be sent or retrieved by calling the API. There are two ways through which the information can be sent or retrieved:

      • Raw: It is normal JSON format in which the request needs to be passed.

        {     
                  "User_name": "Travis",
                  "City": "Denver"
        }

      • Form: Used to map the fields. You can either provide static value or map with the variables.

        The values can be mapped in following way:
         
        Key1: User_name
        Value/Variable1: Travis / #name#
         
        
        Key 2: City
        Value/Variable: Denver / #City#

  1. Response: You can further store the responses received from the API into the variables which can be further used in the bot flow or bot message. ReplyCX follows the dot pattern to store the responses into the variables. Below are a few of the ways in which the path can be defined.

    Object path for storing the response into variable where list is returned
    result.data.list[0].’variable name’
    Here the ‘variable name’ is name of variable where the response will be stored.
    
    
    Object path for storing the response into variable where single value is returned
    result.data.’variable name’
    Here the ‘variable name’ is name of variable where the response will be stored.

Testing the Integration:

You can test the API within the block itself as well as define variables and store the responses in them.

  1. Click on 'Test the API' button.

  2. Provide the input in the variable (optional).

  3. Click on ‘Test the API’ again to check the results.

Storing the Responses:

  1. Click on 'Expand Icon' to expand the results.

  2. Click on ‘+’ sign against the field to store the value into the variable.

  3. Define the variable in 'Save the field in this variable'.

⛓️