Chilkat Online Tools

autoit / Datadog API Collection / Update a webhook

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("custom_headers","ea nostrud in pariatur non")
$oJson.UpdateString("encode_as","json")
$oJson.UpdateString("name","WEBHOOK_NAME")
$oJson.UpdateString("payload","non ")
$oJson.UpdateString("url","https://example.com/webhook")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sName = $oJResp.StringOf("name")
Local $sUrl = $oJResp.StringOf("url")
Local $sCustom_headers = $oJResp.StringOf("custom_headers")
Local $sEncode_as = $oJResp.StringOf("encode_as")
Local $sPayload = $oJResp.StringOf("payload")

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}"
    }
  ]
}