Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'username'
EXEC sp_OASetProperty @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
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'target', 'http://example.com/callback'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'triggers[0]', 'conversation:read'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'triggers[1]', 'conversation:message'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'includeFullUser', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'includeFullSource', 0
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @sbRequestBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PATCH', 'https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/webhooks/:webhookId', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @strVal nvarchar(4000)
DECLARE @Target nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Target OUT, 'webhook.target'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'webhook.id'
DECLARE @Version nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Version OUT, 'webhook.version'
DECLARE @Secret nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Secret OUT, 'webhook.secret'
DECLARE @IncludeFullUser int
EXEC sp_OAMethod @jResp, 'BoolOf', @IncludeFullUser OUT, 'webhook.includeFullUser'
DECLARE @IncludeFullSource int
EXEC sp_OAMethod @jResp, 'BoolOf', @IncludeFullSource OUT, 'webhook.includeFullSource'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'webhook.triggers'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'webhook.triggers[i]'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PATCH
-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/:webhookId
Postman Collection Item JSON
{
"name": "Update Webhook",
"_postman_id": "d32b1f08-8cc7-44be-b53f-4bc850509011",
"request": {
"method": "PATCH",
"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/:webhookId",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"integrations",
":integrationId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "integrationId"
},
{
"key": "webhookId"
}
]
},
"description": "Updates the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration."
},
"response": [
{
"id": "6655db9e-65db-4d6b-9fe0-1cdf14ba0f71",
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"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/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
},
{
"key": "webhookId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "e026a537-ee30-4dee-8b19-20d16233ef80",
"name": "Ok",
"originalRequest": {
"method": "PATCH",
"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/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
},
{
"key": "webhookId"
}
]
}
},
"status": "OK",
"code": 200,
"_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": "e0bc5d65-e439-43b3-adc5-9afecf5cbc3a",
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"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/:webhookId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId",
"webhooks",
":webhookId"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
},
{
"key": "webhookId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
