Chilkat Online Tools

Swift3 / Datadog API Collection / Create a webhooks integration

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "name": "WEBHOOK_NAME",
    //   "url": "https://example.com/webhook",
    //   "custom_headers": "id veniam consectetur ullamco",
    //   "encode_as": "json",
    //   "payload": "do offi"
    // }

    let json = CkoJsonObject()!
    json.update("name", value: "WEBHOOK_NAME")
    json.update("url", value: "https://example.com/webhook")
    json.update("custom_headers", value: "id veniam consectetur ullamco")
    json.update("encode_as", value: "json")
    json.update("payload", value: "do offi")

    http.setRequestHeader("Content-Type", value: "application/json")
    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.postJson3("https://api.app.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var name: String? = jResp.string(of: "name")
    var url: String? = jResp.string(of: "url")
    var custom_headers: String? = jResp.string(of: "custom_headers")
    var encode_as: String? = jResp.string(of: "encode_as")
    var payload: String? = jResp.string(of: "payload")

}

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "name": "WEBHOOK_NAME",
  "url": "https://example.com/webhook",
  "custom_headers": "id veniam consectetur ullamco",
  "encode_as": "json",
  "payload": "do offi"
}'
https://api.app.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks

Postman Collection Item JSON

{
  "name": "Create a webhooks integration",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "integration",
        "webhooks",
        "configuration",
        "webhooks"
      ]
    },
    "description": "Creates an endpoint with the name `<WEBHOOK_NAME>`."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "webhooks",
            "configuration",
            "webhooks"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_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": "POST",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "webhooks",
            "configuration",
            "webhooks"
          ]
        }
      },
      "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": "POST",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "webhooks",
            "configuration",
            "webhooks"
          ]
        }
      },
      "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": "Too many requests",
      "originalRequest": {
        "method": "POST",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/webhooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "webhooks",
            "configuration",
            "webhooks"
          ]
        }
      },
      "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}"
    }
  ]
}