Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.BasicAuth = True
http.Login = "username"
http.Password = "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
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("target","http://example.com/callback")
json.UpdateString("triggers[0]","conversation:read")
json.UpdateString("triggers[1]","conversation:message")
json.UpdateBool("includeFullUser",False)
json.UpdateBool("includeFullSource",False)
http.SetRequestHeader("Content-Type","application/json")
Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/webhooks","application/json",json)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim strVal As String
Dim Target As String = jResp.StringOf("webhook.target")
Dim Id As String = jResp.StringOf("webhook.id")
Dim Version As String = jResp.StringOf("webhook.version")
Dim Secret As String = jResp.StringOf("webhook.secret")
Dim IncludeFullUser As Boolean = jResp.BoolOf("webhook.includeFullUser")
Dim IncludeFullSource As Boolean = jResp.BoolOf("webhook.includeFullSource")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("webhook.triggers")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("webhook.triggers[i]")
i = i + 1
End While
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": ""
}
]
}
