🔌Webhooks and API

Operator AI offers powerful Webhooks and API access — allowing you to customize workflows, push data to external systems, and build deeper integrations.

---

🔌 What Are Webhooks and API Access?

• Webhooks allow Operator AI to send real-time data to external URLs when specific events happen (like new conversations, new users, lead capture, etc.).

• API Access lets you pull or push data into Operator AI — such as creating users, sending messages, or updating profiles.

✅ Together, they make Operator AI extremely flexible and developer-friendly.

---

🛠️ How to Set Up Webhooks

1. Go to Settings → Miscellaneous → Webhooks in your Operator AI Dashboard.

2. Paste your Webhook URL (where you want to receive Operator AI event data).

3. Enable the types of Webhooks you want (e.g., New Conversation, New Message, New User).

4. Save settings and reload Operator AI.

✅ You can send Webhooks to multiple Zaps, endpoints, or servers if needed (separated by commas).

---

🛠️ How to Use the Operator AI API

• API Endpoint Base URL: https://console.heyoperator.ai/script/include/api

• Authentication: Use Bearer tokens for secure access.

• Common API Actions:

  • Get Users (GET /users)

  • Create New User (POST /users)

  • Send Message (POST /messages)

  • Get Conversations (GET /conversations)

  • Update User Profile (PUT /users/{id})

  • Tag User (POST /tags)

✅ Full API documentation is available inside the API Reference section.

---

🔥 Example Webhook Events

Event	Trigger Example
New Conversation	When a visitor starts a new chat session.
New Message	When a user sends a message during a conversation.
Conversation Closed	When a conversation is archived.
New User Created	When a new user profile is created through chat or automation.
Tag Applied	When a specific tag is assigned to a user.

✅ Real-time data lets you build smart workflows and reporting pipelines.

---

📋 Best Practices for Webhooks and API Usage

Tip	Why It Matters
Validate Webhook payloads	Protect your server from invalid or malicious requests.
Use secure HTTPS endpoints	Always encrypt Webhook communications.
Retry on failures	Build retry logic in your webhook receiver.
Rate limit your API calls	Prevent accidental overuse or throttling.
Monitor Webhook delivery	Set up alerts if Webhooks fail repeatedly.

✅ Secure, reliable integrations = professional-grade customer experience.

---

🧠 Bonus: Chaining Webhooks + API

Advanced users can:

• Trigger Webhooks to external systems (Zapier, CRM, Database).

• Use API calls to automatically update Operator AI based on those external actions.

• Example: New user fills out a form → Webhook → CRM → API call tags user as “Qualified Lead”.

✅ You can create full closed-loop automations with Operator AI.

---

🛟 Need Help?

• Explore full API documentation inside the API Reference section.

• Contact [e-mail] for developer support.

• Your Success Manager can suggest architecture tips for advanced workflows.

✅ We’re here to help you integrate without limits.

---

🎯 Next Step

👉 Continue to Designing Effective Flows →