Webhooks

The Webhooks Service supports a communication method between its API and external systems. These webhooks trigger notifications for various events within Clearingworks. Upon an event, Clearingworks sends an HTTP POST request to all registered URLs. The external API should respond promptly as Clearingworks retries failed requests a few times before giving up. Each request includes a key for the receiving API to verify idempotency (ensuring the request is processed only once). Common use cases include receiving login/logout notifications or being alerted when a file upload is complete.

Get registered webhooks.

SecurityJWT
Responses
200

Success

get/cw/webhooks/registration
Request samples 
Response samples 
{
  • "registrationId": "string",
  • "url": "string",
  • "secretKey": "string",
  • "actionType": "string",
  • "severity": "string",
  • "source": "string",
  • "objectType": "string"
}
Register for a webhook.
SecurityJWT 
Request 
Request Body schema: application/x-www-form-urlencoded
url
required
string
The URL that will receive the (POST) notifications.


 
actionType
string
The type of action to receive notifications for. Leave blank to receive notifications for all actions.


 
source
string
The source for notifications. Leave blank to receive notifications from all sources.


 
objectType
string
The type of object to receive notifications for. Leave blank to receive notifications for all objects.


 
severity
string
The severity level of notifications to receive. Leave blank to receive notifications for all severity levels.


 
Responses 
200
Success. Body contains secret key for validating messages.


400
Malformed URL or failed to register webhook.


put/cw/webhooks/registration
Request samples 
application/x-www-form-urlencoded
url=string&actionType=Completed&source=Automation&objectType=Automation&severity=Information
Deregister a webhook.
SecurityJWT 
Request 
Request Body schema: application/x-www-form-urlencoded
registrationId
required
string
The ID of the notification to remove.


 
Responses 
200
Success


delete/cw/webhooks/registration
Request samples 
application/x-www-form-urlencoded
registrationId=string
Get information about webhook fields.
SecurityJWT 
Responses 
200
Success


get/cw/webhooks/info
Request samples 
Response samples 
{
  • "actionTypes": [
    ],
  • "sources": [
    ],
  • "objectTypes": [
    ]
}