Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $http "password"
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "target": "http://example.com/callback",
# "triggers": [
# "conversation:read",
# "conversation:message"
# ],
# "includeFullUser": false,
# "includeFullSource": false
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "target" "http://example.com/callback"
CkJsonObject_UpdateString $json "triggers[0]" "conversation:read"
CkJsonObject_UpdateString $json "triggers[1]" "conversation:message"
CkJsonObject_UpdateBool $json "includeFullUser" 0
CkJsonObject_UpdateBool $json "includeFullSource" 0
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/webhooks" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "webhook": {
# "target": "http://example.com/callback",
# "triggers": [
# "conversation:read",
# "conversation:message"
# ],
# "id": "5e554d2cac66fb73a3c01871",
# "version": "v2",
# "secret": "8564b3e6a8b20a4bdb68b05ce9bc5936",
# "includeFullUser": false,
# "includeFullSource": false
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Target [CkJsonObject_stringOf $jResp "webhook.target"]
set Id [CkJsonObject_stringOf $jResp "webhook.id"]
set Version [CkJsonObject_stringOf $jResp "webhook.version"]
set Secret [CkJsonObject_stringOf $jResp "webhook.secret"]
set IncludeFullUser [CkJsonObject_BoolOf $jResp "webhook.includeFullUser"]
set IncludeFullSource [CkJsonObject_BoolOf $jResp "webhook.includeFullSource"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "webhook.triggers"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "webhook.triggers[i]"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"target": "http://example.com/callback",
"triggers": [
"conversation:read",
"conversation:message"
],
"includeFullUser": false,
"includeFullSource": false
}'
https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/webhooks
Postman Collection Item JSON
{
"name": "Create Webhook",
"_postman_id": "47d7af27-93ff-40c9-9e36-a7342a5d4f8a",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"target\": \"http://example.com/callback\",\n \"triggers\": [\n \"conversation:read\",\n \"conversation:message\"\n ],\n \"includeFullUser\": false,\n \"includeFullSource\": false\n}"
},
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/integrations/:integrationId/webhooks",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"integrations",
":integrationId",
"webhooks"
],
"variable": [
{
"key": "integrationId"
}
]
},
"description": "Creates a new webhook associated with a Sunshine Conversations Connect integration or a custom integration."
},
"response": [
{
"id": "0c6f800c-d3f7-4e7c-ae06-a6cf1e7985d9",
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"target\": \"http://example.com/callback\",\n \"triggers\": [\n \"conversation:read\",\n \"conversation:message\"\n ],\n \"includeFullUser\": false,\n \"includeFullSource\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId",
"webhooks"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "1645606e-cd40-40f5-ae34-6fe7c379886d",
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"target\": \"http://example.com/callback\",\n \"triggers\": [\n \"conversation:read\",\n \"conversation:message\"\n ],\n \"includeFullUser\": false,\n \"includeFullSource\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId",
"webhooks"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"webhook\": {\n \"target\": \"http://example.com/callback\",\n \"triggers\": [\n \"conversation:read\",\n \"conversation:message\"\n ],\n \"id\": \"5e554d2cac66fb73a3c01871\",\n \"version\": \"v2\",\n \"secret\": \"8564b3e6a8b20a4bdb68b05ce9bc5936\",\n \"includeFullUser\": false,\n \"includeFullSource\": false\n }\n}"
},
{
"id": "7cf11ba6-34bb-4e40-9301-a40bbe5499e6",
"name": "Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"target\": \"http://example.com/callback\",\n \"triggers\": [\n \"conversation:read\",\n \"conversation:message\"\n ],\n \"includeFullUser\": false,\n \"includeFullSource\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId",
"webhooks"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "a4f6e8c6-3d78-46b6-af4d-2a4fd70c8295",
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"target\": \"http://example.com/callback\",\n \"triggers\": [\n \"conversation:read\",\n \"conversation:message\"\n ],\n \"includeFullUser\": false,\n \"includeFullSource\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId/webhooks",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId",
"webhooks"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
