YundaDeskConfigure Custom API and event webhooks
Set up developer integrations, callback URLs, signatures, and fixed egress IPs.
Updated 2026-08-09
Hi, where is my package? 📦 I need it next week — could you check?
Order #4821 has shipped and is due by 6:00 PM today. I've also flagged it for expedited delivery.
⋯Perfect, thank you!
Hi Mia, I'm checking your order status now.
PendingHi Mia, I'm checking your order status now.
SentHi Mia, I'm checking your order status now.
DeliveredHi Mia, I'm checking your order status now.
ReadHi Mia, I'm checking your order status now.
Failed to sendInternal send failed, please try again laterHi, our support team has received your order question.
Failed to sendThe channel credential has expired. Please reauthorize and try again.(Demo reply) Test message received; the channel round-trip works.
DeliveredTry the full experience — sign up free or log in.
A white-label chat bubble for your site
Send and receive through your own system
Bring customer email into one inbox
Connect WhatsApp Business to serve customers
Connect Facebook Pages and handle messages
Receive and reply to Instagram DMs
Connect a LINE Official Account
Connect a Telegram bot for customer messages
Pending — subject to TikTok review and authorization
Connect a Zalo Official Account
Receive and reply to comments
Connect official enterprise customer service accounts
Customer contacts, group chats, and agent collaboration
Select customer service accounts
Each selected account becomes an independent channel that is enabled immediately, with AI replies off by default.
Applies only to this Website Widget channel. The channel name and theme color are channel-specific too.
Enter the title, description, and welcome message in one language. They are translated automatically for each visitor and reused afterward.
Copy the code below and paste it into your website to load the chat widget.
Copy it into your website, bot profile, or integration docs.
Copy<script src="https://cdn.yundadesk.com/widget.js" data-yd-key="yd_widget_main" async></script>- Widget Key
- yd_widget_main
- Script URL
- https://cdn.yundadesk.com/widget.js
- Direct link
- https://cdn.yundadesk.com/?widget_key=yd_widget_main
Telegram bot setup guide
Three steps: ① find @BotFather to create a bot and get the token → ② paste the token on the left → ③ save and enable; the system receives new messages automatically.
1. Create a Telegram bot
- In Telegram, search for @BotFather and open the chat.
- Send /newbot to create a new bot.
- Follow the prompts to set a display name and username (ending in _bot).
- Copy the bot token returned by BotFather.
2. Enter the token on the left and enable
- Paste the token into “Bot Token” on the left.
- Click “Save” at the top, then “Enable”.
- Click “Test connection” to verify the bot token works.
3. Test the bot
- Search for the bot username in Telegram and start a chat.
- Send any message and AI / an agent will reply automatically.
- See Telegram Bot API docs.
The channel credential has expired. Please reauthorize and try again.
Connection failedTelegram bot setup guide
Three steps: ① find @BotFather to create a bot and get the token → ② paste the token on the left → ③ save and enable; the system receives new messages automatically.
1. Create a Telegram bot
- In Telegram, search for @BotFather and open the chat.
- Send /newbot to create a new bot.
- Follow the prompts to set a display name and username (ending in _bot).
- Copy the bot token returned by BotFather.
2. Enter the token on the left and enable
- Paste the token into “Bot Token” on the left.
- Click “Save” at the top, then “Enable”.
- Click “Test connection” to verify the bot token works.
3. Test the bot
Callbacks go through YundaDesk fixed secure egress. If your receiver restricts sources, add the egress IPs to its allowlist.
Callbacks go through YundaDesk fixed secure egress. Allowlist these IPs: 203.0.113.10, 203.0.113.11
View allowlist IPsCustom API setup guide
1. Create a Custom API channel
- Enter the channel name and “your system callback URL” on the left.
- After saving, the system generates a connection key and signing key to confirm message ownership and request authenticity.
- (Optional) Add an IP allowlist to restrict sources.
2. Forward customer messages to YundaDesk
- POST messages as JSON to the webhook URL above.
- Include the connection key, timestamp, signature, and idempotency key in the headers.
- A 200 response means received; other statuses are treated as failures and retried.
3. Receive reply pushes
- Once enabled, YundaDesk pushes agent / AI replies to the “your system callback URL” you entered on the left.
- Deduplicate by external message ID for idempotency.
| Event | Time | Status |
|---|---|---|
| message.created | 2026/07/28 14:20 | Delivered |
| message.created | 2026/07/28 14:06 | Timeout · retrying |
| conversation.assigned | 2026/07/28 13:41 | Signature rejected |
Install one YundaDesk plugin to add live chat, AI support, and a secure Widget binding to a WordPress site.
Use the same YundaDesk WordPress plugin; after WooCommerce is detected and authorized read-only, sync store, customer, order, product, and current cart context.
Connect a BigCommerce store, sync customer order context, and show recent orders in the workspace sidebar.
This WordPress site will be linked to the current workspace, then returned to WordPress Admin to complete the PKCE exchange.
- Site
- https://wp-review.yundadesk.com
- Workspace
- YundaDesk Review
- Versions
- YundaDesk 1.0.0 · WordPress 7.0.2
- WooCommerce
- 10.9.4 detected; read-only store access still requires a separate approval after site connection
This confirmation creates only the site binding and public Widget configuration. It does not read WooCommerce store data. Read-only WooCommerce access must be approved separately in WordPress Admin.
| Customer | Contact | Channel / source | Location | Last interaction |
|---|---|---|---|---|
| MMaria Garcia | Web Widget | 05/18 | ||
| LLukas Schneider | Telegram+49 30 123456 | 05/20 | ||
| AAna Silva | 05/22 |
Check whether AI is safe to serve, what it answers from, and what needs you.
3 outreach tasks open
Look it up using the order number.
Last 3 real matches: Web Widget · Custom API — 1 externally delivered, 2 pending verification, 0 failed.| Category | Capability | Status | Current state | Integration path |
|---|---|---|---|---|
| Proactive outreach | Broadcast noticeCreate a broadcast draft for a channel or all reachable customers. | Draft only | Batch delivery is missing, so AI cannot send directly to every customer. | Connect batch delivery; until then, only confirmed drafts are allowed. |
| Proactive outreach | Private customer messagePrepare or send a follow-up to one specific customer. | Not available yet | This plan does not include the capability yet. | This capability is not available yet and requires no setup now. |
| Proactive outreach | Segment outreachFind customers by conditions and draft outreach for that segment. | Needs setup | Customer segment search is missing, so the target audience cannot be located. | Connect customer segment search to enable this capability. |
| Customer data | Customer profile readRead customer profiles to enrich answers, memory, and outreach decisions. | Available | Read customer profiles to enrich answers, memory, and outreach decisions. | Yuna can use this in learning, answering, and outreach decisions. |
↳Yes, Brazil shipping usually takes 7-12 business days.
Human answered·1↳Auto-detect VIP customers · Detect VIP status and prompt agents to follow up first.
Human answered·1·L2 risk↳Opened items can be returned within 30 days if the package is complete.
Human answered·1↳If DHL has not updated for over 72 hours, check the order first, then hand off for compensation review.
You corrected·1·L2 risk| Skill | Status | Use case | Last 7 days | Actions |
|---|---|---|---|---|
| Order tracking lookupWhen a customer asks where an order is, look it up first, then reply in brand voice. | Active | Lookup | Used 12 times92% success | › |
| Auto-detect VIP customersDetect VIP status and prompt agents to follow up first. | Testing | Triage | Not used yet | › |
When a customer asks where an order is, look it up first, then reply in brand voice.
Choose a customer scenario and run a side-effect-free simulation with the production executor.
Simulation never messages customers or performs real external actions.
Shows real customer-conversation calls only; scenario simulations are excluded.
| Dimension | Conversations | Messages | Avg. first response | Resolved | Share |
|---|---|---|---|---|---|
| Web Widget | 712 | 4,128 | 38s | 496 | 60% |
| Telegram | 284 | 1,620 | 45s | 219 | 24% |
| 198 | 980 | 3m 12s | 146 | 17% |
Profile & project
Agent identity
Basic information
Project identity
Team members
| Member | Role | Status & skills | Last sign-in | Last used | Actions |
|---|---|---|---|---|---|
| ACAnna ChenMeanna@yundadesk.testOnline | Admin | ActiveEnglishRefundsMax 12 concurrent | Today, 09:42 | 2 min ago | |
| LWLeo Wangleo@yundadesk.testOnline | Agent | ActiveEnglishAfter-salesMax 6 concurrent | Yesterday, 18:20 | Today, 10:06 | |
| MGMaria Garciamaria@yundadesk.testOffline | Agent | PendingSpanishPre-salesMax 8 concurrent | — | — |
Notifications
Notification permission
Notification settings
Notification scenes
Test notification
Send testSend a test notification to verify everything works.
Send key
Send-key preference for the conversation input, saved per agent.
Proactive outreach
SaveOutreach policy
Anti-spam and confidence
Human review
Subscription & usage
Upgrade planBuy AI CreditPurchase historyContact opsUsage quotas
Entitlement gate
Write actions are allowed based on workspace status, feature flags and quota usage.
Could not establish a secure connection. If the site is HTTP-only, crawl it again with an http:// URL
| Document | Size | Tags | Updated | Status | Actions |
|---|---|---|---|---|---|
| Support knowledge · Notion · 128 docsSource folder · expand to view synced documents | — | — | Last synced 2026/07/29 03:10 | Retrievable | ⋯ |
| Brazil shipping timelinesCompiled 12 FAQ pairs | — | Updated Jun 3, 2026, 4:00 PM | Searchable | ⋯ | |
| EU customs & duties | — | Updated Jun 4, 2026, 2:30 PM | Indexing | ⋯ | |
| 30-day refund policyCompiled 9 FAQ pairs | — | Updated Jun 2, 2026, 8:00 PM | Searchable | ⋯ |
| Document | Size | Tags | Updated | Status | Actions |
|---|---|---|---|---|---|
| Brazil shipping policy | — | Updated Jun 3, 2026, 4:05 PM | Waiting to index | ⋯ | |
| EU customs & duties | — | Updated Jun 4, 2026, 2:30 PM | Indexing | ⋯ | |
| Brazil shipping timelines | — | Updated Jun 3, 2026, 4:00 PM | Searchable | ⋯ | |
| Import restrictions PDFError: The PDF contains no readable text | — | Updated Jun 7, 2026, 4:30 PM | Indexing failed | ⋯ |
| Document | Size | Tags | Updated | Status | Actions |
|---|---|---|---|---|---|
| tgo.ai · 0 pagesProcessed 3 / Discovered 50 pages | — | — | Crawl job running | Crawling | ⋯ |
| tgo.ai · 47 pagesLast sync succeeded · 47 pages | — | — | Last synced Jun 20, 2026, 4:00 PM | Searchable | ⋯ |
| Customer question | Standard answer | Source | Tags | Status | Actions |
|---|---|---|---|---|---|
| Do you ship to Brazil? | Shipping to Brazil usually takes 7-12 business days. | Compiled · Brazil shipping policy | Enabled | ⋯ |
Connect Notion, choose the pages to sync, and import documents automatically.
Connect NotionNotion is not connected yet
agent confirmationCart recovery is ready to reach 1 customer — confirm the flow.
agent confirmationNew FAQ: track packages from the order page after dispatch.
A customer asked about product materials. Review whether it belongs in the learning base.
A Telegram reply was not delivered. Check channel delivery.
An AI reception run failed. You can inspect the answer trail.
Which channel had the most customers in the past week?
The website channel had the most customers in the past week: 42.
Send a Telegram message to Sam about the new product.
VIP customers can get expedited shipping
This looks like a rule you may want to teach me.
VIP customers can get expedited shipping
This looks like a rule you may want to teach me.
Choose how to send
If a customer stops replying for 30 minutes after asking about a product, prepare a follow-up draft, at most once per customer every 24 hours.
Saved as a pending learning suggestion. Review it in AI improvements.
- Trigger
- Trigger after 30m
- AI action
- Prepare a follow-up draft
- Cooldown
- Do not repeat for the same customer within 1d
What needs my attention today?
Three things: 2 learning suggestions to review and 1 outreach waiting for your confirmation. Yesterday's auto-resolution hit 84%, up 3 points.
Choose whether built-in or external AI handles automatic replies.
Both visitors and agents will see this name
Selected channels are handled by the current AI. Channels not selected here will not use AI replies.
SelectTelegramChoose the AI service that replies across all assigned channels.
Maya Sales Advisor
This is the name of the same default AI agent. Visitors and agents see it; switching built-in or external source does not create a second AI.
AI reception source
Built-in and external AI are mutually exclusive. The selected source replies for the channels assigned below.
Use YundaDesk managed growth with YundaDesk AI learning, skill generation, and review.
External AI only handles auto-replies. It does not participate in YundaDesk AI learning or skill generation.
Custom API channels and event webhooks are grouped as developer integrations. Pro, Enterprise, and custom plans that inherit the entitlement can create and enable them.
Custom API channels and event webhooks connect your own systems to YundaDesk. Current availability is shown on the in-product plan page.
What happens after a plan change#
If the workspace moves to a plan that no longer includes a developer-integration capability:
- Existing configuration, signing secrets, and delivery history are preserved.
- The corresponding Custom API channel or event webhook is disabled and stops sending new requests.
- You can still view, disable, or delete existing configuration, but you cannot create, enable, test, replay, or rotate secrets.
- Regaining the entitlement does not restore integrations automatically. Review the configuration and enable it manually.
Configure a callback URL#
A callback or event webhook URL must:
- Be a public
https://URL on port 443. - Contain no username, password, or
#fragment. - Match the saved allowed domain. Use an explicit, controlled wildcard when multiple subdomains are required.
- Accept traffic from the fixed egress IPs published by YundaDesk.
After saving, use the page's test action. A successful test proves that the current request is reachable; before going live, also verify the signature, event payload, and source IP in the receiving system.
Fixed egress IPs#
YundaDesk sends Custom API callbacks and event webhooks from fixed egress IPs. The page keeps egress IPs collapsed by default. When configuring the receiver, select the blue View allowlist IPs link, then add the displayed addresses to the receiving server's allowlist.
If the page says no egress IPs have been published, contact YundaDesk support instead of allowing traffic from every source. The page may show multiple IPs; allow all of them.
Verify requests#
Verify the YundaDesk signature and timestamp in the receiving system, and use the event or delivery ID for idempotency. Do not use source IP as the only authentication control.
Use the public Custom API inbound URL shown in the product. Sending the same signed receipt again does not apply the delivery transition twice.
Troubleshoot delivery failures#
Start with the delivery status and error type on the relevant Custom API or event webhook page:
- Plan or quota blocked: check the current plan and usage.
- URL or domain rejected: verify HTTPS, port, domain, and URL contents.
- Timeout or target unavailable: confirm that the target is online and allows every published egress IP.
- Signature rejected: verify the current secret; after rotation, confirm that the receiver uses the new secret.
Temporary network or DNS failures are retried automatically. After the retry limit is reached, use the replay action provided by the product.