Webhooks
...
Webhook management
Registered
1 min
name endpoint api webhookregistrations method get url https pushtopaystaging crbnj net api webhookregistrations description returns the webhook events you are registered for tab examples examples languages id qr1edng3xuzrq1 kv7fpm language curl code n requestid r4j39qo2dc yp3b 3bt2 5ac9 ffop111slgn0 n callbackurl string n callbackusername string n callbackpassword string n customlabel selectedlanguageid qr1edng3xuzrq1 kv7fpm results languages id epcxf0 bnw65tsgufhddi language 200 customlabel code n registrationid hk76vsmh k7hs 4ch6 7mks nj76clk8h0xk n requestid 7gmlpo54 sn87 2nlg 8clk fhk90xmhu12x n callbackurl www yoururl com n callbackusername jroll n callbackpassword 1234 n merchantid hk7xmlhs 7lkc a0cn aluv hk7xkg67c14l n isactive true n deactivatedat 2020 12 16t09 31 35 622z n isinerrorstate true n errorstatereason string n detectederrorstateat 2020 12 16t09 31 35 622z n selectedlanguageid epcxf0 bnw65tsgufhddi request pathparameters queryparameters headerparameters bodydataparameters 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 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 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 children formdataparameters currentnewparameter label body parameter value bodydataparameters response name registrationid kind optional type string description id of the webhook retrieved 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 string 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