Update by ID

1 min

{ "name" "endpoint /api/webhookregistrations/{registrationid}", "method" "put", "url" "https //pushtopaystaging crbnj net/api/webhookregistrations/{registrationid}", "description" "updates the web address (url) for webhooks you are registered to according to your registration id", "tab" "examples", "examples" { "languages" \[ { "id" "a2ttjky dw7kxhubooh6 ", "language" "curl", "code" "{\n \\"requestid\\" \\"2c0d9149 9de0 465e a556 4caaa8830503\\",\n \\"sourcesenderid\\" \\"b4e85c02 afcc 4901 bf4d 6d3d954fa2b9\\",\n \\"callbackurl\\" \\"string\\",\n \\"callbackusername\\" \\"string\\",\n \\"callbackpassword\\" \\"string\\",\n \\"isactive\\" true\n}", "customlabel" "" } ], "selectedlanguageid" "a2ttjky dw7kxhubooh6 " }, "results" { "languages" \[ { "id" "siawruxfz9lrunrm7umks", "language" "200", "customlabel" "", "code" "{\n \\"registrationid\\" \\"2c0d9149 9de0 465e a556 4caaa8830503\\",\n \\"requestid\\" \\"1e5e1ddb dd91 4228 942d ce45a6fd548d\\",\n \\"callbackurl\\" \\"string\\",\n \\"callbackusername\\" \\"string\\",\n \\"callbackpassword\\" \\"string\\",\n \\"submerchantid\\" \\"2c0d9149 9de0 465e a556 4caaa8830503\\",\n \\"isactive\\" true,\n \\"deactivatedat\\" \\"2023 01 26t10 15 49 097z\\",\n \\"isinerrorstate\\" true,\n \\"errorstatereason\\" \\"string\\",\n \\"detectederrorstateat\\" \\"2023 01 26t10 15 49 097z\\"\n}" } ], "selectedlanguageid" "siawruxfz9lrunrm7umks" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "registrationid", "kind" "required", "type" "string", "description" "unique registration id for a webhook" }, { "name" "requestid", "kind" "optional", "type" "string", "description" "the guid that enables the application to link request with response", "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 cross river's allowlist ssl required ", "" "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 cross river's allowlist ssl required " }, { "name" "callbackusername", "kind" "optional", "type" "string", "description" "authentication data for webhook api calls if the server requires authentication", "children" \[] }, { "name" "callbackpassword", "kind" "optional", "type" "string", "description" "authentication data for webhook api calls if the server requires authentication", "children" \[] }, { "name" "merchantid", "kind" "optional", "type" "string", "description" "identifier of the merchant partner", "children" \[] }, { "name" "isactive", "kind" "optional", "type" "boolean", "description" "true if it is active, otherwise false", "children" \[] }, { "name" "deactivatedat", "kind" "optional", "type" "string", "description" "returns the date and time a webhook was deactivated in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "isinerrorstate", "kind" "optional", "type" "boolean", "description" "true if the webhook is in error status, otherwise false", "children" \[] }, { "name" "errorstatereason", "kind" "optional", "type" "string", "description" "reason the registration is in an error state", "children" \[] }, { "name" "detectederrorstateat", "kind" "optional", "type" "string", "description" "the moment that an error was detected this is important information when troubleshooting a problem in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "registrationid", "kind" "optional", "type" "string", "description" "unique registration id for a webhook" }, { "name" "requestid", "kind" "optional", "type" "string", "description" "the guid that enables the application to link request with response", "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 cross river's allowlist ssl required ", "children" \[] }, { "name" "callbackusername", "kind" "optional", "type" "string", "description" "authentication data for webhook api calls if the server requires authentication", "children" \[] }, { "name" "callbackpassword", "kind" "optional", "type" "string", "description" "authentication data for webhook api calls if the server requires authentication", "children" \[] }, { "name" "submerchantid", "kind" "optional", "type" "string", "description" "identifier of the merchant partner", "children" \[] }, { "name" "isactive", "kind" "optional", "type" "boolean", "description" "true if the card is active, otherwise false", "children" \[] }, { "name" "deactivatedat", "kind" "optional", "type" "string", "description" "date and time card was deactivated, if relevant, in date time format in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] }, { "name" "isinerrorstate", "kind" "optional", "type" "boolean", "description" "true if the webhook is in error status, otherwise false", "children" \[] }, { "name" "errorstatereason", "kind" "optional", "type" "string", "description" "reason the registration is in an error state", "children" \[] }, { "name" "detectederrorstateat", "kind" "optional", "type" "string", "description" "time the error was detected in this case, the date and time are in this format yyyy mm ddthh\ mm\ ss\[ mmm]", "children" \[] } ] }