Webhooks
...
Webhook management
Ping by ID
1 min
{ "name" "endpoint /webhooks/v1/registrations/{id}/ping", "method" "put", "url" "https //sandbox crbcos com/webhooks/v1/registrations/{id}/ping", "description" "ping a webhook registration by id to check the status ", "tab" "examples", "examples" { "languages" \[ { "id" "clebco 2wl3a16buk3pxm", "language" "curl", "code" "curl location globoff request put 'https //sandbox crbcos com/webhooks/v1/registrations/{id}/ping?id=8d6115c0 2a88 4a58 b731 b306002e8bc2'", "customlabel" "" }, { "id" "jvtgnuipm1gx09xe4zuqh", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'put',\n 'hostname' 'sandbox crbcos com',\n 'path' '/webhooks/v1/registrations/{id}/ping?id=8d6115c0 2a88 4a58 b731 b306002e8bc2',\n 'headers' {\n },\n 'maxredirects' 20\n};\n\nvar req = https request(options, function (res) {\n var chunks = \[];\n\n res on(\\"data\\", function (chunk) {\n chunks push(chunk);\n });\n\n res on(\\"end\\", function (chunk) {\n var body = buffer concat(chunks);\n console log(body tostring());\n });\n\n res on(\\"error\\", function (error) {\n console error(error);\n });\n});\n\nreq end();", "customlabel" "" }, { "id" "la4c5 g o7jo 9hlkg0p", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/webhooks/v1/registrations/{id}/ping?id=8d6115c0 2a88 4a58 b731 b306002e8bc2\\"\n\npayload = {}\nheaders = {}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "54upzsvg6magkrcmko8bo", "language" "ruby", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //sandbox crbcos com/webhooks/v1/registrations/{id}/ping?id=8d6115c0 2a88 4a58 b731 b306002e8bc2\\"\n method = \\"put\\"\n\n client = \&http client {\n }\n req, err = http newrequest(method, url, nil)\n\n if err != nil {\n fmt println(err)\n return\n }\n res, err = client do(req)\n if err != nil {\n fmt println(err)\n return\n }\n defer res body close()\n\n body, err = io readall(res body)\n if err != nil {\n fmt println(err)\n return\n }\n fmt println(string(body))\n}", "customlabel" "" }, { "id" "jizrlaowc4ur8v5eg2hbi", "language" "go", "code" "", "customlabel" "" } ], "selectedlanguageid" "clebco 2wl3a16buk3pxm" }, "results" { "languages" \[ { "id" "tbg1 bvjgumgovntay8pg", "language" "202", "customlabel" "", "code" "" } ], "selectedlanguageid" "tbg1 bvjgumgovntay8pg" }, "request" { "pathparameters" \[ { "name" "id", "kind" "required", "type" "string", "description" "the webhook registration id you receive this id in the response when you register a webhook event this id is in guid format ", "children" \[] } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "the webhook registration id you receive this id in the response when you register a webhook event this id is in guid format " }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "your id in the cr system this id is in guid format ", "children" \[] }, { "name" "eventname", "kind" "optional", "type" "string", "description" "webhook event being reported", "children" \[] }, { "name" "callbackurl", "kind" "optional", "type" "string", "description" "the value is a url webhooks are reported to this url as a result of a triggered action make sure the callback url is added to cr's allowlist ssl required ", "children" \[] }, { "name" "authusername", "kind" "optional", "type" "string", "description" "basic authentication username to include in header of event 255 character limit ", "children" \[] }, { "name" "authpassword", "kind" "optional", "type" "string", "description" "basic authentication password to include in event header 255 character limit ", "children" \[] }, { "name" "consecutiveerrors", "kind" "optional", "type" "integer", "description" "the number of consecutive errors", "children" \[] }, { "name" "lasterror", "kind" "optional", "type" "string", "description" "description of the last error", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "status of registration \n active\n suspended\n restarting", "children" \[] }, { "name" "type", "kind" "optional", "type" "string", "description" "type of registration \n push\n poll", "children" \[] }, { "name" "format", "kind" "optional", "type" "string", "description" "event format \n basic\n extended", "children" \[] } ] }