Webhook management: COS
Webhook intro
Webhooks return events after an API endpoint is called. The returned webhook event contains details relevant to the API call.
Each webhook event has request and response codes.
Get started with Cross River APIs
GET calls
- Add query parameters to filter the response the API returns to general GET calls.
- Use pagination to control presentation of your results.
API calls
Action | API call | Description |
|---|---|---|
Register | POST /v1/registrations | Registers for webhook event delivery |
GET /v1/registrations/ | Returns a list of all webhook registrations and their statuses | |
GET /v1/registrations/{id} | Returns a list of all webhook registrations and their statuses 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 |