Webhook event configuration

Overview

Webhooks allow your application to receive real-time notifications when events occur in Synchr.ai. Instead of polling the API, webhooks push data to your endpoint whenever something happens.

Setting Up Webhooks

1. Navigate to Settings > API > Webhooks
2. Click "Add Endpoint"
3. Enter your webhook URL (must be HTTPS)
4. Select the events you want to subscribe to
5. Click "Save" to activate the webhook

Available Events

• sync.started — A sync operation has begun
• sync.completed — A sync operation finished successfully
• sync.failed — A sync operation encountered an error
• sync.conflict — A data conflict was detected
• connection.created — A new connection was established
• connection.disconnected — A connection was lost or removed
• record.created — A new record was synced
• record.updated — An existing record was updated

Webhook Payload

Each webhook delivery includes a JSON payload with the event type, timestamp, and relevant data. All payloads include a signature header for verification:

X-Synchr-Signature: sha256=abc123...

Retry Policy

If your endpoint returns a non-2xx status code, Synchr.ai retries the delivery up to 5 times with exponential backoff. After 5 failed attempts, the webhook is marked as failing and you receive an email notification.

Testing Webhooks

Use the "Send Test Event" button in the webhook settings to deliver a sample payload to your endpoint for testing.