Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Go to Haptik Website
  • Contact Us
  • Home
  • Developer Guides

Types of API Integrations available on Haptik Bot

Written by Medha Anand

Updated on April 19th, 2023

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Getting Started
    Build Deploy Analyse Manage Account Bot Deactivation
  • Bot Building
    Essentials Smart Skills Steps User Messages Bot Responses Entities Connections Customisations User feedback collection Testing Whatsapp Bots NLU Bot Maintenance
  • Smart Agent Chat
    Set up Admin Settings MyChats Section (Agent Inbox) Live Traffic Section Teams Section Archives Section Analytics Plans on Smart Agent Chat
  • Conversation Design
    Design Basics Design Guides Designing for Platforms Designing WhatsApp Bots
  • Developer Guides
    Code Step Integration Static Step Integration Shopify Integration SETU Integration Exotel Integration CIBIL integration Freshdesk KMS Integration PayU Integration Zendesk Guide Integration Twilio Integration Razorpay Integration LeadSquared Integration USU(Unymira) Integration Helo(VivaConnect) Integration Salesforce KMS Integration Stripe Integration PayPal Integration CleverTap Integration Fynd Integration HubSpot Integration Magento Integration WooCommerce Integration Microsoft Dynamics 365 Integration
  • Deployment
    Web SDK WhatsApp Facebook Instagram Sunshine Conversation LINE Google Business Messages Telegram MS Teams Bot as an API iOS SDK Android SDK
  • External Agent Tool Setup
    Zendesk Chat Salesforce Service Cloud Freshchat Zoho NICE CXOne Gorgias
  • Analytics & Reporting
    Intelligent Analytics
  • Notifications
    SMS Notifications Success Measurement
  • Commerce Plus
    Catalog Integration Bot Building Guide Channel Deployments Unified ML Pipeline Documentation
  • Troubleshooting Guides
    Error Messages FAQs
  • Release Notes
+ More

Table of Contents

What are Integrations?Types of IntegrationsIntegrations via Code step using Code EditorIntegrations via Static Step using Integrations TabChoosing the type of IntegrationWhen to use Code Steps?When to use Static step integrations?

What are Integrations?

Integrations allow you to connect your IVA to external services to perform dynamic operations like fetching data, posting data, or performing some business logic over the collected entities from the IVA.

Types of Integrations

Haptik's Conversation Studio tool supports two types of integrations. They are

  1. Integrations via Code Step using Code Editor
  2. Integrations via Static Step using Integrations Tab

Integrations via Code step using Code Editor

Code Step provides an option of Code Editor where you can write your custom python code to communicate with the external service and execute the business logic.

Code Step is a type of step which contains all the business logic to integrate a function. To know more about Code Step please read here.

Code Editor is a feature using which we can write our Python code and integration functions. The supported programming language is Python 3 and above. If any syntax errors or exceptions are raised by the main function, this will result in a Bot Break message.

Stages to add your APIs -

  • Initialize variables to use the collected information in entities
  • Pass the information to the API
  • Fetch the values back from API
  • Log the details using logger package
  • Change the final_response
  • Run the code
  • Provide Sample Output
  • Create an Output Step to display the output on the bot

Integrations via Static Step using Integrations Tab

Static Step provides an option for integrations. In this mode of integration, you provide an API URL to which the entity data will be passed as a POST request with a JSON payload. The API URL is then expected to return the bot response in a JSON format.

You will see a red color API icon mark on top of the Static steps which uses this type of integration.

Choosing the type of Integration

It is important to choose the right type of integration for your use case as this will increase the speed of shipping the IVA and also help in long-term maintainability.

When to use Code Steps?

In most cases, you should be using Code Step's Code Editor. Here are some sample scenarios:

  • Integrating with APIs from external providers where they have their own request and response formats
  • Performing business logic validations or calculations on the collected entities
  • Posting or fetching data from external data stores or services
  • OTP verification

You can read more about the Code Editor Integration here.

When to use Static step integrations?

This should only be used in very complex cases where a middleware service needs to be built or the code is too complicated. Some scenarios where you should be using the API integrations are:

  • Having Custom authentication and data storage requirements
  • Integrating with APIs from external providers where they understand Haptik's request and response formats

You can read more about it here.

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • What is Static Step Integration
  • What are Different Integration Parameters
  • What is Code Step? How to Use Code Step?

Platform

  • Conversation Studio
  • Smart Skills
  • Advanced NLU
  • Intelligent Analytics
  • Omnichannel
  • Smart Agent Chat
  • Enterprise Security
  • Integrations

Solutions

  • Conversational Commerce
  • Lead Generation
  • Customer Care
  • WhatsApp
  • Conversational IVR
  • Google Business Messages

Industries

  • Retail/ E-Commerce
  • Financial Services
  • Travel & Hospitality
  • Telecom

Knowledge

  • ROI Calculator
  • Reports & Research
  • Case Studies
  • Webinars
  • ISAT
  • Tech Blog
  • Business Blog
  • Resources
  • Haptik v/s Yellow
  • Haptik v/s Liveperson
  • Haptik v/s IBM Watson
  • Haptik v/s Verloop
  • Conversations on AI

Company

  • Why Haptik
  • About Us
  • Careers
  • News & Media
  • Awards & Recognition
  • Contact Us
  • Partnerships
  • Investor Relations

Subscribe

Sign up to recieve the latest updates

Find us on

  • Twitter-footer
  • Linkedin-footer
  • YT-footer
  • Insta-footer
  • G2-footer
  • Facebook-footer

Knowledge Base Software powered by Helpjuice

Copyright © jio Haptik Technology Limited 2021 | Data Security & Privacy Policy | GDPR

North America | Asia Pacific | Africa | enterprise@haptik.ai

Definition by Author

0
0