Webhooks and Events | Kota Embed Documentation

Use webhooks to capture events that occur in your Kota integration. Webhooks are essential for handling asynchronous events and triggering additional actions in your platform.

Critical Events to Handle

Certain events require immediate action to ensure employers and employees are informed of time-sensitive developments:

employer.health_insurance.quote.action_required - Employer must take action on their health insurance quote
employee.health_insurance.offer.action_required - Employee must take time-sensitive action on their policy offer
Future events for policy renewal windows

We consider handling these events and immediately notifying your users as critical to a successful integration.

Communicating Required Actions

Events with action_required typically contain a required_action object to help you present information clearly to end users.

Using the required_action object:

reason - Use as the message title
reason_description - Use as the message body (see example)
due_at - Display the deadline prominently

Example:

1 {
2   "required_action": {
3     "reason": "Additional information needed",
4     "reason_description": "Your health insurance quote requires additional company information to proceed.",
5     "due_at": "2024-02-15T17:00:00Z"
6   }
7 }

Using Kota’s messaging helps ensure you don’t accidentally step into regulated activities by using your own language around insurance sales and renewals. Consider making it clear the language is from Kota’s platform.

Critical Events to Handle

Communicating Required Actions

Resources