Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcUrl
LOCAL lcContent_type
LOCAL lcSecret
LOCAL lcDescription
LOCAL lcId
LOCAL lnIs_active
LOCAL lcDate
LOCAL lcCode
LOCAL lcResponse
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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>"
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("url","<string>")
loJson.UpdateString("content_type","json")
loJson.UpdateString("secret","<string>")
loJson.UpdateString("events[0]","position.update")
loJson.UpdateString("events[1]","document.create")
loJson.UpdateString("description","<string>")
loJson.UpdateString("id","<long>")
loJson.UpdateBool("is_active",0)
loJson.UpdateString("last_response.date","<dateTime>")
loJson.UpdateString("last_response.code","<integer>")
loJson.UpdateString("last_response.response","<string>")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.easybill.de/rest/v1/webhooks/:id",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcUrl = loJResp.StringOf("url")
lcContent_type = loJResp.StringOf("content_type")
lcSecret = loJResp.StringOf("secret")
lcDescription = loJResp.StringOf("description")
lcId = loJResp.StringOf("id")
lnIs_active = loJResp.BoolOf("is_active")
lcDate = loJResp.StringOf("last_response.date")
lcCode = loJResp.StringOf("last_response.code")
lcResponse = loJResp.StringOf("last_response.response")
i = 0
lnCount_i = loJResp.SizeOfArray("events")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("events[i]")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
