Webhooks & Events
Learn how to set up and handle webhooks to receive real-time notifications from Xharvoc services.
Webhook Overview
Webhooks allow your application to receive real-time notifications when events occur in Xharvoc. Instead of polling for updates, webhooks push data to your endpoint as events happen.
Setting Up Webhooks
- 1Create a publicly accessible HTTPS endpoint in your application
- 2Register the endpoint in the Xharvoc dashboard or via API
- 3Select the events you want to receive
- 4Implement endpoint logic to handle incoming events
- 5Respond with HTTP 200 to acknowledge receipt
Event Types
Available webhook events include:
- conversation.created - New conversation started
- conversation.message - New message in conversation
- conversation.ended - Conversation concluded
- workflow.started - Workflow execution began
- workflow.completed - Workflow finished successfully
- workflow.failed - Workflow encountered an error
Webhook Security
Verify webhook signatures to ensure requests are from Xharvoc:
import { verifyWebhookSignature } from '@xharvoc/sdk';
const isValid = verifyWebhookSignature(
request.body,
request.headers['x-xharvoc-signature'],
webhookSecret
);Important
Always verify webhook signatures. Never process unverified webhook payloads.
Was this article helpful?
Help us improve our documentation
Related Articles
API Documentation
Comprehensive documentation for Xharvoc's REST APIs, including authentication, endpoints, and examples.
SDK Installation Guide
Step-by-step instructions for installing and configuring Xharvoc SDKs in your development environment.
Custom Development
Guidelines and best practices for extending Xharvoc solutions with custom development.