Chilkat Online Tools

PureBasic / Datadog API Collection / Update a Slack integration channel

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.

    ; {
    ;   "display": {
    ;     "message": true,
    ;     "notified": true,
    ;     "snapshot": true,
    ;     "tags": true
    ;   },
    ;   "name": "#general"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateBool(json,"display.message",1)
    CkJsonObject::ckUpdateBool(json,"display.notified",1)
    CkJsonObject::ckUpdateBool(json,"display.snapshot",1)
    CkJsonObject::ckUpdateBool(json,"display.tags",1)
    CkJsonObject::ckUpdateString(json,"name","#general")

    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,"PATCH","https://api.app.ddog-gov.com/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_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)

    ; {
    ;   "display": {
    ;     "message": true,
    ;     "notified": true,
    ;     "snapshot": true,
    ;     "tags": true
    ;   },
    ;   "name": "#general"
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    Message.i = CkJsonObject::ckBoolOf(jResp,"display.message")
    Notified.i = CkJsonObject::ckBoolOf(jResp,"display.notified")
    Snapshot.i = CkJsonObject::ckBoolOf(jResp,"display.snapshot")
    Tags.i = CkJsonObject::ckBoolOf(jResp,"display.tags")
    name.s = CkJsonObject::ckStringOf(jResp,"name")


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PATCH
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "display": {
    "message": true,
    "notified": true,
    "snapshot": true,
    "tags": true
  },
  "name": "#general"
}'
https://api.app.ddog-gov.com/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name

Postman Collection Item JSON

{
  "name": "Update a Slack integration channel",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"display\": {\n    \"message\": true,\n    \"notified\": true,\n    \"snapshot\": true,\n    \"tags\": true\n  },\n  \"name\": \"#general\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "integration",
        "slack",
        "configuration",
        "accounts",
        ":account_name",
        "channels",
        ":channel_name"
      ],
      "variable": [
        {
          "key": "account_name",
          "value": "tempor Ut sed velit"
        },
        {
          "key": "channel_name",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Update a channel used in your Datadog-Slack integration."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "PATCH",
        "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  \"display\": {\n    \"message\": true,\n    \"notified\": true,\n    \"snapshot\": true,\n    \"tags\": true\n  },\n  \"name\": \"#general\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "slack",
            "configuration",
            "accounts",
            ":account_name",
            "channels",
            ":channel_name"
          ],
          "variable": [
            {
              "key": "account_name"
            },
            {
              "key": "channel_name"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"display\": {\n    \"message\": true,\n    \"notified\": true,\n    \"snapshot\": true,\n    \"tags\": true\n  },\n  \"name\": \"#general\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PATCH",
        "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  \"display\": {\n    \"message\": true,\n    \"notified\": true,\n    \"snapshot\": true,\n    \"tags\": true\n  },\n  \"name\": \"#general\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "slack",
            "configuration",
            "accounts",
            ":account_name",
            "channels",
            ":channel_name"
          ],
          "variable": [
            {
              "key": "account_name"
            },
            {
              "key": "channel_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": "PATCH",
        "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  \"display\": {\n    \"message\": true,\n    \"notified\": true,\n    \"snapshot\": true,\n    \"tags\": true\n  },\n  \"name\": \"#general\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "slack",
            "configuration",
            "accounts",
            ":account_name",
            "channels",
            ":channel_name"
          ],
          "variable": [
            {
              "key": "account_name"
            },
            {
              "key": "channel_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": "PATCH",
        "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  \"display\": {\n    \"message\": true,\n    \"notified\": true,\n    \"snapshot\": true,\n    \"tags\": true\n  },\n  \"name\": \"#general\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "slack",
            "configuration",
            "accounts",
            ":account_name",
            "channels",
            ":channel_name"
          ],
          "variable": [
            {
              "key": "account_name"
            },
            {
              "key": "channel_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": "PATCH",
        "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  \"display\": {\n    \"message\": true,\n    \"notified\": true,\n    \"snapshot\": true,\n    \"tags\": true\n  },\n  \"name\": \"#general\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/integration/slack/configuration/accounts/:account_name/channels/:channel_name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "integration",
            "slack",
            "configuration",
            "accounts",
            ":account_name",
            "channels",
            ":channel_name"
          ],
          "variable": [
            {
              "key": "account_name"
            },
            {
              "key": "channel_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}"
    }
  ]
}