Webhook registration
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 |
POST /v1/registrations | Registers for webhook event delivery | |
GET /v1/registrations/ | Returns a list of all webhook registrationsby event delivery or by polling the system | |
GET /v1/registrations/{id} | Returns a webhook registration by ID | |
PUT /v1/registrations/{id}/restart | Restarts a webhook registration by ID | |
DELETE /v1/registrations/{id} | Deletes a webhook registration by ID | |
PUT /v1/registrations/{id}/ping | Calls a webhook registration to check its status | |
PUT /v1/registrations/{id} | Updates the details of a webhook registration by ID |
Request attributes
Returns a list of all webhook registrations by event delivery.
Add query parameters to filter the response the API returns to all GET calls.
Ping a webhook registration by ID to check the status.