How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
- Application Reference:
com.hornbill.servicemanager
- Scope:
Global
- Class:
Application
- Required Privilege Level:
user
- Required Rights: Group H - executeSystemAPIs
Description
This operation posts an update to a Request's Timeline. For use with chatbot integrations.
Request Parameters
The chatbotUpdateReqTimeline API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.
Name | Type | Required | Description |
---|---|---|---|
requestId |
xs:string |
Yes | This parameter must be set with the Id of a Request. |
userId |
xs:string |
Yes | This parameter must be set with the Id of the chatbot session user. |
content |
xs:string |
Yes | This parameter must be set with the content of the Timeline entry. |
extra |
xs:string |
No | A JSON structure representing additional content for the Timeline entry. |
visibility |
xs:string |
No | This parameter must be set with the visibility of the Timeline entry. The options are public, trustedGuest, colleague, manager and owner. |
activityType |
xs:string |
No | This parameter can be set with activity type that is associated to the Timeline entry. For example, "System" is used for generic updates. |
skipBpm |
xs:boolean |
No | This parameter determines whether the Request's process is resumed following the Timeline update. By default, this parameter is set to "false". |
Response Parameters
Name | Type | Description |
---|---|---|
outcome |
xs:string |
This parameter is set with the outcome of the operation. The options are "success" and "failure". |
error |
xs:string |
This parameter is set with validation errors. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.servicemanager","@method":"chatbotUpdateReqTimeline","params":{"requestId":"xs:string","userId":"xs:string","content":"xs:string","extra":"xs:string","visibility":"xs:string","activityType":"xs:string","skipBpm":false}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("requestId", "xs:string")
hornbillAPI.SetParam("userId", "xs:string")
hornbillAPI.SetParam("content", "xs:string")
hornbillAPI.SetParam("extra", "xs:string")
hornbillAPI.SetParam("visibility", "xs:string")
hornbillAPI.SetParam("activityType", "xs:string")
hornbillAPI.SetParam("skipBpm", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager", "chatbotUpdateReqTimeline")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager";
const payload = {
"@service": "apps/com.hornbill.servicemanager",
"@method": "chatbotUpdateReqTimeline",
"params": {
"requestId": "xs:string",
"userId": "xs:string",
"content": "xs:string",
"extra": "xs:string",
"visibility": "xs:string",
"activityType": "xs:string",
"skipBpm": false
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager";
const payload = {
"@service": "apps/com.hornbill.servicemanager",
"@method": "chatbotUpdateReqTimeline",
"params": {
"requestId": "xs:string",
"userId": "xs:string",
"content": "xs:string",
"extra": "xs:string",
"visibility": "xs:string",
"activityType": "xs:string",
"skipBpm": false
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager";
$payload = (object) [
'@service' => 'apps/com.hornbill.servicemanager',
'@method' => 'chatbotUpdateReqTimeline',
'params' => (object) [
'requestId' => 'xs:string',
'userId' => 'xs:string',
'content' => 'xs:string',
'extra' => 'xs:string',
'visibility' => 'xs:string',
'activityType' => 'xs:string',
'skipBpm' => 'xs:boolean',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager"
$Body = @{
"@service" = "apps/com.hornbill.servicemanager"
"@method" = "chatbotUpdateReqTimeline"
params = @{
requestId = "xs:string"
userId = "xs:string"
content = "xs:string"
extra = "xs:string"
visibility = "xs:string"
activityType = "xs:string"
skipBpm = "xs:boolean"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.servicemanager",
"@method":"chatbotUpdateReqTimeline",
"params":{
"requestId":"xs:string",
"userId":"xs:string",
"content":"xs:string",
"extra":"xs:string",
"visibility":"xs:string",
"activityType":"xs:string",
"skipBpm":"xs:boolean",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document