Webhooks Guide

Chatofy can send outbound webhooks to your server when specific events occur. Webhooks enable real-time integrations with your backend systems.

Available Events

• message.received — A new message is received from a customer
• message.sent — A message was sent successfully
• message.delivered — A message was delivered to the recipient
• message.read — A message was read by the recipient
• message.failed — A message delivery failed
• contact.created — A new contact was created or upserted
• contact.updated — Contact fields or attributes were updated
• contact.deleted — A contact was soft-deleted
• contact.restored — A contact was restored from soft-deletion
• contact.merged — Duplicate contacts were merged
• deal.created — A new deal was created
• deal.updated — Deal attributes or owner were updated
• deal.stage_changed — Deal was moved to a new pipeline stage
• deal.won — Deal was moved to a won stage
• deal.lost — Deal was moved to a lost stage with a lost reason
• deal.deleted — A deal was soft-deleted
• deal.restored — A deal was restored from soft-deletion
• conversation.status_changed — A conversation was resolved or reopened

Configuring a Webhook

1. Navigate to Settings → Webhooks
2. Click "Add Webhook"
3. Enter the Endpoint URL (your server endpoint)
4. Select the events you want to subscribe to
5. Optionally enter a Secret for HMAC signature verification
6. Click "Save"

Webhook Payload Format

Webhooks are sent as HTTP POST requests with a JSON payload:

Signature Verification

If you set a secret, Chatofy signs each webhook with an HMAC-SHA256 signature. Verify the signature in your webhook handler to ensure the request is legitimate from Chatofy.