🔗Webhooks Overview

Webhooks allow Operator AI to send real-time event data to your systems — enabling automation, integration, and real-time reactions outside of Operator.

🔗 What Are Webhooks?

  • When an event happens in Operator AI (e.g., a new conversation, new user, lead captured), Operator can automatically send a POST request with the event data to your external URL.

  • Your system can then process, store, or act based on that information.

✅ Webhooks make Operator AI deeply connected to your stack — instantly.

📈 Common Webhook Events Available

Event
When It Triggers

New Conversation

A visitor or user starts a new chat or interaction.

New Message

A new message is sent in a conversation (user or agent side).

New User

A new user is created (from signup, chat start, API call, etc.).

Conversation Closed

A conversation is archived or ended.

Tag Applied

A user gets tagged via automation, agent, or system event.

Lead Captured

A Flow successfully captures a lead (email, phone, etc.).

✅ Covering the most important user interaction and automation points.

🛠️ How to Set Up Webhooks

  1. Log into your Operator AI Dashboard.

  2. Go to Settings → Miscellaneous → Webhooks.

  3. Enter your Webhook URL (must be HTTPS).

  4. Select the types of events you want to subscribe to.

  5. Save your settings.

✅ Now Operator AI will start POSTing event payloads to your endpoint.

🔥 Example Webhook Payload

Example for a New Conversation event:

{
  "event": "new_conversation",
  "data": {
    "conversation_id": "123456",
    "user_id": "78910",
    "channel": "web",
    "started_at": "2025-04-11T14:22:05Z"
  }
}

✅ Your server will receive real-time JSON payloads you can use in your systems.

📋 Best Practices for Webhooks

Tip
Why It Matters

Always respond with 2xx HTTP codes

Operator expects a successful response (like 200 OK).

Implement retries for failures

Webhooks should retry if delivery fails temporarily.

Validate incoming Webhooks

Use HMAC signatures (optional) or check payload structure to prevent spoofing.

Log received Webhooks

Useful for debugging and monitoring.

Keep your Webhook URL private

Avoid exposure to random POST requests.

✅ Well-handled Webhooks = real-time reliability and scaling.

🧠 Advanced: Multiple Webhook URLs

  • You can send Webhooks to multiple Zapier zaps or endpoints by entering comma-separated URLs.

  • Example: https://hooks.zapier.com/abcd, https://api.yourcrm.com/webhook

✅ Distribute events flexibly across your connected tools.

🛟 Need Help?

  • Explore Webhook setup and payload examples inside this documentation.

  • Contact support@heyoperator.ai for Webhook debugging help.

  • Your Success Manager can help architect real-time automations using Webhooks + API.

✅ We’re here to make your systems smarter and faster.

🎯 Next Step

👉 Continue to Example API Requests →

PreviousAvailable EndpointsNextExample API Requests

Last updated