ixHello
ixHello Customer
ixHello Customer
  • About iX Hello
  • General
    • iX Hello: Create Account
    • iX Hello: Basic Mode
      • Webchat Assistant
        • Direct Chat Link
        • Embedded Chat Assistant
      • Digital Assistant
        • Digital Avatar
        • Kiosk Mode
      • Call/SMS Assistant
      • Administrative Purpose
    • iX Hello: Studio Mode
      • Prerequisites
      • Steps
        • App Creation
        • Data Source Configuration
        • AI Content Setup
        • Method Setup
        • Intent Setup
        • Slot Setup
        • Utterance Setup
        • Input Setup
        • Input Parameter Setup
        • Publish Setup
        • Test
        • Enable Call /SMS
    • Enterprise Connections
      • Generative AI
      • Internal Content
      • Microsoft Office 365
    • AI Contents
      • Add AI Content
    • Use cases
      • Contact Finder with Salesforce
        • Pre-requisites
          • An active Salesforce account
          • Lex Developer Account
          • Integrate Salesforce with iX Hello
        • Build Custom App
      • Contact Finder with REST API
        • Prerequisites
          • Integrate API Service with iX Hello
          • Lex Developer Account
        • Build Custom App
  • Apps
    • App Templates
    • NLP Custom App
    • Custom App Series - Step 1 - Building a Custom App
    • Custom App Series - Step 2 - Creating a Connection
    • Custom App Series - Step 3 - Publishing to a Channel
    • Lex Auto Publishing Setup
    • Office 365 SharePoint - Custom App
    • Office365 Exchange - Custom App
    • SalesForce Custom App
    • App Template Export & Import
    • IntentFeature BeforeAfterMethod
    • iX Hello Supported Periods Date Range
    • Shared App
    • ExecuteJS
  • Connections
    • Amazon Web Services
      • Amazon Kendra
      • Amazon Lambda
        • Amazon Lambda: Create Lambda Function
          • Amazon Lambda: iX Hello Integration
      • DynamoDB
    • Login with Amazon Setup
    • SalesForce
      • SalesForce: Create an account
      • SalesForce: Connect to iX Hello
    • Microsoft Office365 Integration Guide
    • Microsoft Office365 AAD
    • MS SQL Server
    • Twilio
  • Blueprints
    • Create App Using App Blueprints
    • Lex Bot using Appointment Blueprint
    • Domain App using Internal Data
    • Domain App S3 Data Source Setup
  • Channels
    • Amazon Alexa
      • Create Amazon Developer Account
      • Registering Alexa User Account
      • Alexa Account Linking to iX Hello
    • Amazon Lex
    • Amazon Lex Integration
    • Amazon Connect and Lex Bot Integration
  • JSON Methods
    • Internal Data JSON Methods
  • Solutions
  • AWS IAM users
  • Finding AWS Region
  • Glossary
Powered by GitBook
On this page

Was this helpful?

  1. General
  2. Use cases
  3. Contact Finder with REST API
  4. Prerequisites

Integrate API Service with iX Hello

PreviousPrerequisitesNextLex Developer Account

Last updated 8 days ago

Was this helpful?

You could integrate any public API-Service with iX Hello with a simple set up. For this demonstration, we'll be using a third party sample API service.

On the left navigation, go to Integrations-> Connect System and Add New Connection.

On the resulting screen, Connect External System and choose System Type: Rest API Service and click on Next.

Now provide configurations for the API service you are trying to connect and click on Validate System.

Field
Value

System Instance Name

Unique name to identify your connection

e.g.API Service

Authorization Type

Authorization type

Options:

a. No Auth

b. Bearer Token

c. Digest Auth

d. OAuth 1.0

e. OAuth 2.0

f. AWS Signature

g. NLM Authentication

e.g. No Auth

Base API URL

The application will try to validate and establish a connection, upon success, you'll be able to save the integration.

Congratulations, you've successfully integrated to your API service with iX Hello. The created connection shall be available in the list of connections.

Base URL e.g.

https://jsonplaceholder.typicode.com/users