Webhook Integration

Overview

Our webhook system enables real-time notifications when a new event ocurred for the company you want. This allows you to instantly receive and process updates without having to repeatedly poll our API.

Event Types

Currently, we support the following event:

clientview_updated - Triggered when a new ClientView model is generated for the company

Setup Instructions

To set up a webhook, you need to provide the following information:

Field	Description	Required
`url`	The endpoint URL where webhook notifications will be sent	✅Yes
`header_name`	Name of the authentication header (e.g.,`Authorization`, `X-API-Key`)	✅Yes
`prefix`	Optional prefix for the authentication value (e.g., `Bearer`, `Token`)	❌No
`auth_secret`	Secret value for authentication	✅Yes

Request Format

When a webhook event is triggered, our system will send an HTTP POST request to your specified URL with the following:

Headers

Content-Type: application/json
{header_name}: {prefix} {auth_secret}

Example

url: https://yoururl.com
header_name: Authorization
prefix: X-API-KEY
auth_secret: secret_api_key

Webhook triggers a POST request to https://yoururl.com with the following headers:

Content-Type: application/json
Authorization: X-API-KEY secret_api_key

Body

ClientView Updated

{
  "event_type": "clientview_updated",
  "company_id": "139",
}

Need Help?

If you encounter any issues with webhook configuration or delivery, please contact your Sales Representative