{"id":27048,"date":"2021-03-17T06:08:39","date_gmt":"2021-03-17T06:08:39","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-2\/?p=27048"},"modified":"2022-09-27T15:17:04","modified_gmt":"2022-09-27T14:17:04","slug":"alert-task-webhook-api-request","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-2\/docs\/bots\/bot-builder-tool\/alert\/alert-task-webhook-api-request\/","title":{"rendered":"Alert Task \u2013 WebHook API Request"},"content":{"rendered":"

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 <\/span>here<\/span><\/a>.<\/span><\/p>\n

For an Alert task with the <\/span>Connection Type<\/strong> specified as <\/span>Webhook<\/strong>, you will need to define:<\/span><\/p>\n

<\/div><\/div>\n

Content Type <\/span><\/span><\/h1>\n

The <\/span>Content Type <\/strong>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 <\/span>Content Type<\/strong> tab and select one of these options:<\/span>
\n\"\"<\/a><\/p>\n

    \n
  1. JSON<\/strong> – 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.<\/span><\/li>\n
  2. RSS<\/strong> – 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.<\/span><\/li>\n
  3. XML<\/strong> – 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.<\/span><\/li>\n
  4. URL Encoded JSON<\/strong> – URLs using JSON encoding for reserved characters.<\/span><\/li>\n
  5. CSV<\/strong> – Comma-separated value lists.<\/span><\/li>\n
  6. Text<\/strong> – Text-based key-value pairs.<\/span><\/li>\n
  7. Twitter Encoded JSON<\/strong> – URLs for Twitter using JSON encoding for reserved characters.<\/span><\/li>\n
  8. Multipart\/Form-data<\/strong> – 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<\/span>.<\/strong><\/li>\n
  9. Multipart\/Related<\/strong> – Used when the same information is presented in different body parts in different forms. The body parts are ordered by increasing complexity.<\/span><\/li>\n
  10. Oracle ADF<\/strong> – For Oracle Application Development Framework.<\/span><\/li>\n<\/ol>\n
    <\/div><\/div>\n

    The Sample Response<\/span><\/span><\/h1>\n

    The Sample<\/strong> Response <\/strong>section lets you define key-value pairs that you expect to receive in the <\/span>Alert <\/span>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 <\/span>Response Sample<\/strong> section are available as drop-down choices for handling the output data.<\/span>
    <\/span>To Add a Sample Response<\/span><\/p>\n

      \n
    1. On the <\/span>API Request<\/strong> tab, expand the <\/span>Sample Response<\/strong> section.<\/span><\/li>\n
    2. Enter your Response Sample<\/strong> that contains the key-value pairs from your JSON response payload. Do one of the following:<\/span>\n
        \n
      1. To format the view of the response as a JSON structure with indentation as shown in the following illustration, click the <\/span>Formatted<\/strong> icon.<\/span><\/li>\n

        \"\"<\/a><\/p>\n

      2. To format the view of the response in serialized compact form, click the <\/span>Unformatted<\/strong> icon.<\/span><\/li>\n<\/ol>\n<\/li>\n
        <\/div><\/div>\n

        Alert Tasks Path <\/span><\/span><\/h1>\n


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

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

        a href=”https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-2\/wp-content\/uploads\/sites\/45\/20220927122821\/alert-task-path.png”>\"\"<\/a>
        \n<\/span>For example, in the following <\/span>Response Sample<\/strong>, you may only want to expose the <\/span>user<\/span> data in the alert task response by defining the <\/span>user<\/span> in the <\/span>Alert Tasks Path<\/strong> field.<\/span><\/p>\n\n\n\n
        {<\/code>
           \"user\":{<\/code>
              \"timeZone\":\"Asia\/Kolkata\",<\/code>
              \"active\":\"true\",<\/code>
              \"displayName\":\"John Doe\",<\/code>
              \"avatarUrls\":{<\/code>
                 \"32x32\":\"https:\/\/koreteam.atlassian.net\/secure\/useravatar?size=medium&ownerId=john.doe&avatarId=11801\",<\/code>
                 \"16x16\":\"https:\/\/koreteam.atlassian.net\/secure\/useravatar?size=xsmall&ownerId=john.doe&avatarId=11801\",<\/code>
                 \"24x24\":\"https:\/\/koreteam.atlassian.net\/secure\/useravatar?size=small&ownerId=john.doe&avatarId=11801\",<\/code>
                 \"48x48\":\"https:\/\/koreteam.atlassian.net\/secure\/useravatar?ownerId=john.doe&avatarId=11801\"<\/code>
              },<\/code>
              \"emailAddress\":\"john.doe@kore.com\",<\/code>
              \"key\":\"john.doe\",<\/code>
              \"name\":\"john.doe\",<\/code>
              \"self\":\"https:\/\/koreteam.atlassian.net\/rest\/api\/2\/user?username=john.doe\"<\/code>
           },<\/code>
           \"webhookEvent\":\"jira:issue_updated\",<\/code>
           \"timestamp\":\"1438431826045\",<\/code>
           \"user_key\":\"john.doe\",<\/code>
           \"user_id\":\"john.doe\"<\/code>
        }<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n


        <\/span>   <\/span>After you enter the <\/span>Alert Tasks Path<\/strong> field, click <\/span>Save<\/strong>.<\/span><\/p>\n

         <\/p>\n","protected":false},"excerpt":{"rendered":"

        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…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[67],"tags":[],"class_list":["post-27048","post","type-post","status-publish","format-standard","hentry","category-alert"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/27048","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/comments?post=27048"}],"version-history":[{"count":5,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/27048\/revisions"}],"predecessor-version":[{"id":45740,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/posts\/27048\/revisions\/45740"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/media?parent=27048"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/categories?post=27048"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-2\/wp-json\/wp\/v2\/tags?post=27048"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}