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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "url": "<string>",
-- "content_type": "json",
-- "secret": "<string>",
-- "events": [
-- "position.update",
-- "document.create"
-- ],
-- "description": "<string>",
-- "id": "<long>",
-- "is_active": false,
-- "last_response": {
-- "date": "<dateTime>",
-- "code": "<integer>",
-- "response": "<string>"
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'url', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content_type', 'json'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'secret', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'events[0]', 'position.update'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'events[1]', 'document.create'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'description', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'id', '<long>'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'is_active', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'last_response.date', '<dateTime>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'last_response.code', '<integer>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'last_response.response', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{apiKey}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api.easybill.de/rest/v1/webhooks/:id', @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
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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)
-- {
-- "url": "<string>",
-- "content_type": "json",
-- "secret": "<string>",
-- "events": [
-- "position.update",
-- "document.create"
-- ],
-- "description": "<string>",
-- "id": "<long>",
-- "is_active": false,
-- "last_response": {
-- "date": "<dateTime>",
-- "code": "<integer>",
-- "response": "<string>"
-- }
-- }
-- 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 @url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'url'
DECLARE @content_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @content_type OUT, 'content_type'
DECLARE @secret nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @secret OUT, 'secret'
DECLARE @description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'description'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @is_active int
EXEC sp_OAMethod @jResp, 'BoolOf', @is_active OUT, 'is_active'
DECLARE @Date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Date OUT, 'last_response.date'
DECLARE @Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'last_response.code'
DECLARE @Response nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Response OUT, 'last_response.response'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'events'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'events[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 PUT
-H "Authorization: {{apiKey}}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"url": "<string>",
"content_type": "json",
"secret": "<string>",
"events": [
"position.update",
"document.create"
],
"description": "<string>",
"id": "<long>",
"is_active": false,
"last_response": {
"date": "<dateTime>",
"code": "<integer>",
"response": "<string>"
}
}'
https://api.easybill.de/rest/v1/webhooks/:id
Postman Collection Item JSON
{
"name": "Update WebHook",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"<string>\",\n \"content_type\": \"json\",\n \"secret\": \"<string>\",\n \"events\": [\n \"position.update\",\n \"document.create\"\n ],\n \"description\": \"<string>\",\n \"id\": \"<long>\",\n \"is_active\": false,\n \"last_response\": {\n \"date\": \"<dateTime>\",\n \"code\": \"<integer>\",\n \"response\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/webhooks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"webhooks",
":id"
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of WebHook"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"<string>\",\n \"content_type\": \"json\",\n \"secret\": \"<string>\",\n \"events\": [\n \"position.update\",\n \"document.create\"\n ],\n \"description\": \"<string>\",\n \"id\": \"<long>\",\n \"is_active\": false,\n \"last_response\": {\n \"date\": \"<dateTime>\",\n \"code\": \"<integer>\",\n \"response\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/webhooks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"webhooks",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"url\": \"<string>\",\n \"content_type\": \"json\",\n \"secret\": \"<string>\",\n \"events\": [\n \"position.update\",\n \"document.create\"\n ],\n \"description\": \"<string>\",\n \"id\": \"<long>\",\n \"is_active\": false,\n \"last_response\": {\n \"date\": \"<dateTime>\",\n \"code\": \"<integer>\",\n \"response\": \"<string>\"\n }\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"<string>\",\n \"content_type\": \"json\",\n \"secret\": \"<string>\",\n \"events\": [\n \"position.update\",\n \"document.create\"\n ],\n \"description\": \"<string>\",\n \"id\": \"<long>\",\n \"is_active\": false,\n \"last_response\": {\n \"date\": \"<dateTime>\",\n \"code\": \"<integer>\",\n \"response\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/webhooks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"webhooks",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"url\": \"<string>\",\n \"content_type\": \"json\",\n \"secret\": \"<string>\",\n \"events\": [\n \"position.update\",\n \"document.create\"\n ],\n \"description\": \"<string>\",\n \"id\": \"<long>\",\n \"is_active\": false,\n \"last_response\": {\n \"date\": \"<dateTime>\",\n \"code\": \"<integer>\",\n \"response\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/webhooks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"webhooks",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
