Chilkat Online Tools

Perl / Datadog API Collection / Update a webhook

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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 = chilkat::CkJsonObject->new();
$json->UpdateString("custom_headers","ea nostrud in pariatur non");
$json->UpdateString("encode_as","json");
$json->UpdateString("name","WEBHOOK_NAME");
$json->UpdateString("payload","non ");
$json->UpdateString("url","https://example.com/webhook");

$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Accept","application/json");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks/:webhook_name",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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 = $jResp->stringOf("name");
$url = $jResp->stringOf("url");
$custom_headers = $jResp->stringOf("custom_headers");
$encode_as = $jResp->stringOf("encode_as");
$payload = $jResp->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}"
    }
  ]
}