GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On (SSO)
Two-Factor Authentication (2FA)
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Builder
  5. Alert Task
  6. Alert Task – WebHook API Request

Alert Task – WebHook API Request

In this article, we will see how to configure an API Request for a WebHook service Alert Task.You can learn more about Alert Tasks here.

For an Alert task with the Connection Type specified as Webhook, you will need to define:

Content Type 

The Content Type describes the type of data exchanged between the XO Platform and your website or application, and the key-value pairs expected in the task payload response. To define the Content Type for the API Request, expand the Content Type tab and select one of these options:

  1. JSON – JavaScript Object Notation is an open standard format using human-readable text to transmit data objects as attribute-value pairs. You can use JSON to transmit data between the Kore.ai servers and your web application.
  2. RSS – Rich Site Summary, or Really Simple Syndication, is a family of standardized formats used to publish frequently updated information such as blog entries, news headlines, audio, and video.
  3. XML – Extensible Markup Language is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. Oftentimes, web services use XML schemas to process the XML data.
  4. URL Encoded JSON – URLs using JSON encoding for reserved characters.
  5. CSV – Comma-separated value lists.
  6. Text – Text-based key-value pairs.
  7. Twitter Encoded JSON – URLs for Twitter using JSON encoding for reserved characters.
  8. Multipart/Form-data – An encoding type that allows files to be sent through an HTTP POST request method if you want to allow a user to upload a file from a form.
  9. Multipart/Related – Used when the same information is presented in different body parts in different forms. The body parts are ordered by increasing complexity.
  10. Oracle ADF – For Oracle Application Development Framework.

The Sample Response

The Sample Response section lets you define key-value pairs that you expect to receive in the Alert task payload. The keys that you provide are available as drop-down choices for handling the data to display to the end-user. When you define the response sample, the keys specified in the Response Sample section are available as drop-down choices for handling the output data.
To Add a Sample Response

  1. On the API Request tab, expand the Sample Response section.
  2. Enter your Response Sample that contains the key-value pairs from your JSON response payload. Do one of the following:
    1. To format the view of the response as a JSON structure with indentation as shown in the following illustration, click the Formatted icon.
    2. To format the view of the response in serialized compact form, click the Unformatted icon.
  3. Alert Tasks Path 


    The last section, Alert Tasks Path lets you define a specific path for data from the API. This is an optional field that you can use to specify if the Response Sample section contains a hierarchical tree structure of data and you only want a specific hierarchical level submitted for the task request object.

    To define the Alert Tasks Path for an alert task using a webhook, on the API Request tab, click the Expand icon in the Alert Tasks Path section as shown in the fo<llowing illustration.

    a href=”https://kore-wordpress.s3.us-east-2.amazonaws.com/developer.kore.ai/v10-1/wp-content/uploads/sites/35/20220927122821/alert-task-path.png”>
    For example, in the following Response Sample, you may only want to expose the user data in the alert task response by defining the user in the Alert Tasks Path field.

    {
       "user":{
          "timeZone":"Asia/Kolkata",
          "active":"true",
          "displayName":"John Doe",
          "avatarUrls":{
             "32x32":"https://koreteam.atlassian.net/secure/useravatar?size=medium&ownerId=john.doe&avatarId=11801",
             "16x16":"https://koreteam.atlassian.net/secure/useravatar?size=xsmall&ownerId=john.doe&avatarId=11801",
             "24x24":"https://koreteam.atlassian.net/secure/useravatar?size=small&ownerId=john.doe&avatarId=11801",
             "48x48":"https://koreteam.atlassian.net/secure/useravatar?ownerId=john.doe&avatarId=11801"
          },
          "emailAddress":"john.doe@kore.com",
          "key":"john.doe",
          "name":"john.doe",
          "self":"https://koreteam.atlassian.net/rest/api/2/user?username=john.doe"
       },
       "webhookEvent":"jira:issue_updated",
       "timestamp":"1438431826045",
       "user_key":"john.doe",
       "user_id":"john.doe"
    }


      After you enter the Alert Tasks Path field, click Save.

     

Alert Task – WebHook API Request

In this article, we will see how to configure an API Request for a WebHook service Alert Task.You can learn more about Alert Tasks here.

For an Alert task with the Connection Type specified as Webhook, you will need to define:

Content Type 

The Content Type describes the type of data exchanged between the XO Platform and your website or application, and the key-value pairs expected in the task payload response. To define the Content Type for the API Request, expand the Content Type tab and select one of these options:

  1. JSON – JavaScript Object Notation is an open standard format using human-readable text to transmit data objects as attribute-value pairs. You can use JSON to transmit data between the Kore.ai servers and your web application.
  2. RSS – Rich Site Summary, or Really Simple Syndication, is a family of standardized formats used to publish frequently updated information such as blog entries, news headlines, audio, and video.
  3. XML – Extensible Markup Language is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. Oftentimes, web services use XML schemas to process the XML data.
  4. URL Encoded JSON – URLs using JSON encoding for reserved characters.
  5. CSV – Comma-separated value lists.
  6. Text – Text-based key-value pairs.
  7. Twitter Encoded JSON – URLs for Twitter using JSON encoding for reserved characters.
  8. Multipart/Form-data – An encoding type that allows files to be sent through an HTTP POST request method if you want to allow a user to upload a file from a form.
  9. Multipart/Related – Used when the same information is presented in different body parts in different forms. The body parts are ordered by increasing complexity.
  10. Oracle ADF – For Oracle Application Development Framework.

The Sample Response

The Sample Response section lets you define key-value pairs that you expect to receive in the Alert task payload. The keys that you provide are available as drop-down choices for handling the data to display to the end-user. When you define the response sample, the keys specified in the Response Sample section are available as drop-down choices for handling the output data.
To Add a Sample Response

  1. On the API Request tab, expand the Sample Response section.
  2. Enter your Response Sample that contains the key-value pairs from your JSON response payload. Do one of the following:
    1. To format the view of the response as a JSON structure with indentation as shown in the following illustration, click the Formatted icon.
    2. To format the view of the response in serialized compact form, click the Unformatted icon.
  3. Alert Tasks Path 


    The last section, Alert Tasks Path lets you define a specific path for data from the API. This is an optional field that you can use to specify if the Response Sample section contains a hierarchical tree structure of data and you only want a specific hierarchical level submitted for the task request object.

    To define the Alert Tasks Path for an alert task using a webhook, on the API Request tab, click the Expand icon in the Alert Tasks Path section as shown in the fo<llowing illustration.

    a href=”https://kore-wordpress.s3.us-east-2.amazonaws.com/developer.kore.ai/v10-1/wp-content/uploads/sites/35/20220927122821/alert-task-path.png”>
    For example, in the following Response Sample, you may only want to expose the user data in the alert task response by defining the user in the Alert Tasks Path field.

    {
       "user":{
          "timeZone":"Asia/Kolkata",
          "active":"true",
          "displayName":"John Doe",
          "avatarUrls":{
             "32x32":"https://koreteam.atlassian.net/secure/useravatar?size=medium&ownerId=john.doe&avatarId=11801",
             "16x16":"https://koreteam.atlassian.net/secure/useravatar?size=xsmall&ownerId=john.doe&avatarId=11801",
             "24x24":"https://koreteam.atlassian.net/secure/useravatar?size=small&ownerId=john.doe&avatarId=11801",
             "48x48":"https://koreteam.atlassian.net/secure/useravatar?ownerId=john.doe&avatarId=11801"
          },
          "emailAddress":"john.doe@kore.com",
          "key":"john.doe",
          "name":"john.doe",
          "self":"https://koreteam.atlassian.net/rest/api/2/user?username=john.doe"
       },
       "webhookEvent":"jira:issue_updated",
       "timestamp":"1438431826045",
       "user_key":"john.doe",
       "user_id":"john.doe"
    }


      After you enter the Alert Tasks Path field, click Save.

     

Menu