Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "custom_headers": "ea nostrud in pariatur non",
; "encode_as": "json",
; "name": "WEBHOOK_NAME",
; "payload": "non ",
; "url": "https://example.com/webhook"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"custom_headers","ea nostrud in pariatur non")
CkJsonObject::ckUpdateString(json,"encode_as","json")
CkJsonObject::ckUpdateString(json,"name","WEBHOOK_NAME")
CkJsonObject::ckUpdateString(json,"payload","non ")
CkJsonObject::ckUpdateString(json,"url","https://example.com/webhook")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.app.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "name": "WEBHOOK_NAME",
; "url": "https://example.com/webhook",
; "custom_headers": "id veniam consectetur ullamco",
; "encode_as": "json",
; "payload": "do offi"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
name.s = CkJsonObject::ckStringOf(jResp,"name")
url.s = CkJsonObject::ckStringOf(jResp,"url")
custom_headers.s = CkJsonObject::ckStringOf(jResp,"custom_headers")
encode_as.s = CkJsonObject::ckStringOf(jResp,"encode_as")
payload.s = CkJsonObject::ckStringOf(jResp,"payload")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"custom_headers": "ea nostrud in pariatur non",
"encode_as": "json",
"name": "WEBHOOK_NAME",
"payload": "non ",
"url": "https://example.com/webhook"
}'
https://api.app.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks/:webhook_name
Postman Collection Item JSON
{
"name": "Update a webhook",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ea nostrud in pariatur non\",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"non \",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name",
"value": "tempor Ut sed velit"
}
]
},
"description": "Updates the endpoint with the name `<WEBHOOK_NAME>`."
},
"response": [
{
"name": "OK",
"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": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ea nostrud in pariatur non\",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"non \",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"WEBHOOK_NAME\",\n \"url\": \"https://example.com/webhook\",\n \"custom_headers\": \"id veniam consectetur ullamco\",\n \"encode_as\": \"json\",\n \"payload\": \"do offi\"\n}"
},
{
"name": "Bad Request",
"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": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ea nostrud in pariatur non\",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"non \",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Authentication error",
"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": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ea nostrud in pariatur non\",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"non \",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Item Not Found",
"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": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ea nostrud in pariatur non\",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"non \",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Too many requests",
"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": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"custom_headers\": \"ea nostrud in pariatur non\",\n \"encode_as\": \"json\",\n \"name\": \"WEBHOOK_NAME\",\n \"payload\": \"non \",\n \"url\": \"https://example.com/webhook\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"webhooks",
":webhook_name"
],
"variable": [
{
"key": "webhook_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
