Webhook registration

8min

Webhooks return events after an API endpoint is called. The returned webhook event contains details relevant to the API call.
Find these APIs in the webhook module of our COS sandbox.
﻿Get started﻿ with Cross River APIs
This table presents APIs we describe in detail.
Action
API call
Description
﻿Sign up for webhook events﻿ 
POST /v1/registrations
Registers for webhook event delivery
﻿Get webhook registrations﻿ 
GET /v1/registrations/
Returns a list of all webhook registrationsby event delivery or by polling the system
﻿Get webhook registrations by ID﻿ 
GET /v1/registrations/{id}
Returns a webhook registration by ID
﻿Restart a webhook registration by ID﻿ 
PUT /v1/registrations/{id}/restart
Restarts a webhook registration by ID
﻿Delete webhook registration by ID﻿ 
DELETE /v1/registrations/{id}
Deletes a webhook registration by ID
﻿Ping a webhook registration by ID﻿ 
PUT /v1/registrations/{id}/ping
Calls a webhook registration to check its status
﻿Update a webhook registration by ID﻿ 
PUT /v1/registrations/{id}
Updates the details of a webhook registration by ID
Register for webhook events
Request attributes 
POST
Request
Response
Body Parameters
partnerId
required
String
Your ID in the CR system. This ID is in GUID format.
eventName
required
String
Webhook event being reported
callbackUrl
optional
String
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.
authUsername
optional
String
Basic authentication username to include in header of event. 255 character limit.
authPassword
optional
String
Basic authentication password to include in event header. 255 character limit.
type
optional
String
Type of registration:
-Push
-Poll
format
optional
String
Type of JSON:
-Basic
-Extended
﻿
Get webhook registrations
Returns a list of all webhook registrations by event delivery.
Add query parameters to filter the response the API returns to all GET calls.
GET
Request
Response
Query Parameters
partnerId
optional
String
Your ID in the CR system. This ID is in GUID format.
eventName
optional
String
Webhook event being reported
callbackUrl
optional
String
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.
pageNumber
optional
Integer
Current page number determined by the total number of records and the number of records per page
pageSize
optional
Integer
Number of records to list on a page. Maximum is 50.
﻿
Get webhook registrations by ID
GET
Request
Response
Path Params
id
required
String
The webhook registration ID. You receive this ID in the response when you register a webhook event. This ID is in GUID format.
﻿
Restart a webhook registration by ID
PUT
Request
Response
Path Params
id
optional
String
The webhook registration ID. You receive this ID in the response when you register a webhook event. This ID is in GUID format.
﻿
Delete webhook registration by ID
DELETE
Request
Response
Path Params
id
required
String
The webhook registration ID. You receive this ID in the response when you register a webhook event. This ID is in GUID format.
﻿
Ping a webhook registration by ID
Ping a webhook registration by ID to check the status.
PUT
Request
Response
Path Params
id
required
String
The webhook registration ID. You receive this ID in the response when you register a webhook event. This ID is in GUID format.
﻿
﻿
Update a webhook registration by ID
PUT
Request
Response
Path Params
id
optional
String
The webhook registration ID. You receive this ID in the response when you register a webhook event. This ID is in GUID format.
partnerId
required
String
Your ID in the CR system. This ID is in GUID format.
eventName
required
String
Webhook event being reported 255 character limit.
callbackUrl
optional
String
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. 255 character limit
authuserName
optional
String
Basic authentication username to include in header of event. 255 character limit.
authPassword
optional
String
Basic authentication password to include in event header. 255 character limit.
consecutiveErrors
optional
String
lastError
optional
String
Status
optional
String
Status of registration:
- Active
- Suspended
- Restarting
type
optional
String
Type of registration:
- Push
- Poll
- File
format
optional
String
Event format:
- Basic
- Extended
﻿
﻿

🤔

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.

﻿

Updated 30 Sep 2024

Did this page help you?

Banking and payments

Webhook events

Action	API call	Description
Sign up for webhook events	POST /v1/registrations	Registers for webhook event delivery
Get webhook registrations	GET /v1/registrations/	Returns a list of all webhook registrationsby event delivery or by polling the system
Get webhook registrations by ID	GET /v1/registrations/{id}	Returns a webhook registration by ID
Restart a webhook registration by ID	PUT /v1/registrations/{id}/restart	Restarts a webhook registration by ID
Delete webhook registration by ID	DELETE /v1/registrations/{id}	Deletes a webhook registration by ID
Ping a webhook registration by ID	PUT /v1/registrations/{id}/ping	Calls a webhook registration to check its status
Update a webhook registration by ID	PUT /v1/registrations/{id}	Updates the details of a webhook registration by ID