Register

{ "name" "endpoint /webhooks/v1/registrations", "method" "post", "url" "https //sandbox crbcos com/webhooks/v1/registrations", "description" "registers for webhook event delivery", "tab" "examples", "examples" { "languages" \[ { "id" "k11qc5kmtxi07enz61ymd", "language" "curl", "code" "curl location 'https //sandbox crbcos com/webhooks/v1/registrations' \\\\\n data '{\n \\"partnerid\\" \\"19222b81 0e1e 452d a842 b2f1011c16f3\\",\n \\"eventname\\" \\"cards card activated\\",\n \\"callbackurl\\" \\"https //webhook site/27b9814b 16eb 4099 9999 32594aee5e04\\",\n \\"type\\" \\"push\\",\n \\"format\\" \\"extended\\"\n}\n\n'", "customlabel" "" }, { "id" "p2tmlg28z74vo1e4pgyqc", "language" "nodejs", "code" "var https = require('follow redirects') https;\nvar fs = require('fs');\n\nvar options = {\n 'method' 'post',\n 'hostname' 'sandbox crbcos com',\n 'path' '/webhooks/v1/registrations',\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\nvar postdata = \\"{\\\r\\\n \\\\\\"partnerid\\\\\\" \\\\\\"19222b81 0e1e 452d a842 b2f1011c16f3\\\\\\",\\\r\\\n \\\\\\"eventname\\\\\\" \\\\\\"cards card activated\\\\\\",\\\r\\\n \\\\\\"callbackurl\\\\\\" \\\\\\"https //webhook site/27b9814b 16eb 4099 9999 32594aee5e04\\\\\\",\\\r\\\n \\\\\\"type\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"format\\\\\\" \\\\\\"extended\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\";\n\nreq write(postdata);\n\nreq end();", "customlabel" "" }, { "id" "spxpi1oypv2sihlcz4tvl", "language" "python", "code" "import requests\n\nurl = \\"https //sandbox crbcos com/webhooks/v1/registrations\\"\n\npayload = \\"{\\\r\\\n \\\\\\"partnerid\\\\\\" \\\\\\"19222b81 0e1e 452d a842 b2f1011c16f3\\\\\\",\\\r\\\n \\\\\\"eventname\\\\\\" \\\\\\"cards card activated\\\\\\",\\\r\\\n \\\\\\"callbackurl\\\\\\" \\\\\\"https //webhook site/27b9814b 16eb 4099 9999 32594aee5e04\\\\\\",\\\r\\\n \\\\\\"type\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"format\\\\\\" \\\\\\"extended\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\"\nheaders = {}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "uywmy4guujem ehqbqcrt", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //sandbox crbcos com/webhooks/v1/registrations\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest body = \\"{\\\r\\\n \\\\\\"partnerid\\\\\\" \\\\\\"19222b81 0e1e 452d a842 b2f1011c16f3\\\\\\",\\\r\\\n \\\\\\"eventname\\\\\\" \\\\\\"cards card activated\\\\\\",\\\r\\\n \\\\\\"callbackurl\\\\\\" \\\\\\"https //webhook site/27b9814b 16eb 4099 9999 32594aee5e04\\\\\\",\\\r\\\n \\\\\\"type\\\\\\" \\\\\\"push\\\\\\",\\\r\\\n \\\\\\"format\\\\\\" \\\\\\"extended\\\\\\"\\\r\\\n}\\\r\\\n\\\r\\\n\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" }, { "id" "hujyaezpnn56wuuaaqquv", "language" "go", "code" "package main\n\nimport (\n \\"fmt\\"\n \\"strings\\"\n \\"net/http\"\n \\"io\\"\n)\n\nfunc main() {\n\n url = \\"https //sandbox crbcos com/webhooks/v1/registrations\\"\n method = \\"post\\"\n\n payload = strings newreader(`{`+\\"\n\\"+`\n \\"partnerid\\" \\"19222b81 0e1e 452d a842 b2f1011c16f3\\",`+\\"\n\\"+`\n \\"eventname\\" \\"cards card activated\\",`+\\"\n\\"+`\n \\"callbackurl\\" \\"https //webhook site/27b9814b 16eb 4099 9999 32594aee5e04\\",`+\\"\n\\"+`\n \\"type\\" \\"push\\",`+\\"\n\\"+`\n \\"format\\" \\"extended\\"`+\\"\n\\"+`\n}`+\\"\n\\"+`\n`+\\"\n\\"+`\n`)\n\n client = \&http client {\n }\n req, err = http newrequest(method, url, payload)\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" "" } ], "selectedlanguageid" "k11qc5kmtxi07enz61ymd" }, "results" { "languages" \[ { "id" "b7qqxvpja iw0itj3v9ed", "language" "200", "customlabel" "", "code" "{\n \\"id\\" \\"8d6115c0 2a88 4a58 b731 b306002e8bc2\\",\n \\"partnerid\\" \\"19222b81 0e1e 452d a842 b2f1011c16f3\\",\n \\"eventname\\" \\"cards card activated\\",\n \\"callbackurl\\" \\"https //webhook site/27b9814b 16eb 4099 9999 32594aee5e04\\",\n \\"consecutiveerrors\\" 0,\n \\"status\\" \\"active\\",\n \\"type\\" \\"push\\",\n \\"format\\" \\"extended\\"\n}" }, { "id" "5i16u7wevlux fmcmrfny", "language" "400", "code" "{\n \\"errors\\" \[\n {\n \\"code\\" 2002,\n \\"message\\" \\"registration for event name already exists\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "b7qqxvpja iw0itj3v9ed" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "partnerid", "kind" "required", "type" "string", "description" "your id in the cross river system this id is in guid format ", "" "your id in the cross river system this id is in guid format " }, { "name" "eventname", "kind" "required", "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 your 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" "type", "kind" "optional", "type" "string", "description" "type of registration \n push\n poll\n file", "" "type of registration \n push\n poll\n file" }, { "name" "format", "kind" "optional", "type" "string", "description" "type of json \n basic\n extended", "" "type of json \n basic\n extended" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "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" "string", "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\n file", "children" \[] }, { "name" "format", "kind" "optional", "type" "string", "description" "event format \n basic\n extended", "children" \[] } ] }