Documentation Index
Fetch the complete documentation index at: https://docs.getmateo.com/llms.txt
Use this file to discover all available pages before exploring further.
With the hellomateo Embed, you can integrate your customer chats directly into your own systems β for example, your ERP, CRM, or internal dashboard.
This makes communication faster, easier, and keeps your team in one workspace.
π§ Two ways to show your inbox
You can embed either a single conversation or your entire inbox.
Option 1: Single conversation
Show only one customer chat β perfect for displaying the chat directly in your ERP next to a contact.
π URL format:
https://app.getmateo.com/embed/conversations/<conversation_id>/single
Option 2: Full inbox
Display all your conversations in one view.
π URL:
https://app.getmateo.com/embed/conversations
To make it work, simply add your employee access token at the end of the URL:
?access_token=<employee_token>
β
Examples:
Single conversation:
https://app.getmateo.com/embed/conversations/12345/single?access_token=abcd1234
Full inbox:
https://app.getmateo.com/embed/conversations?access_token=abcd1234
If you want to show the chat for a specific customer, youβll need their conversation ID.
Hereβs how to find it via the API (for example, using the external_id):
1οΈβ£ Get the conversation by external ID
curl --request GET --url "https://integration.getmateo.com/api/v1/contact?external_id=eq.<external_id>&select=conversation(id)" --header "Authorization: Bearer <token>"
Youβll receive a conversation.id in the response β use it in your embed link.
π Create an Employee Token
If you donβt have an employee token yet, you can create one in your hellomateo account:
- Go to Settings β Integrations β Employee Tokens
- Click Create Employee Token
- Enter a token name, select the employee, and click Create Token
- Copy and save the token β it will only be shown once
π§ Pre-filling Conversations via URL
You can now create links that automatically pre-fill conversation recipients. Users will review and confirm before sending.
https://[your-domain]/conversations/new?channel_id=[CHANNEL_ID]&handle=[RECIPIENT1,RECIPIENT2,...]
Required Parameters
channel_id: The UUID of your channel (get this from your channel settings)
handle: Comma-separated recipient handles (phone, email, etc.)
β οΈ Important: URL Encoding
Special characters MUST be encoded:
| Character | Encoded As |
|---|
+ (plus) | %2B |
| Space | %20 |
@ (at) | %40 |
, (comma) | %2C (optional, but recommended) |
Please note that if you donβt want to encode it manually (recommended), then enter the handles normally with the symbols and let the AI encode ONLY THE PARAMATERS and not the whole url
Working Examples
Single Recipient - Phone with + (Encoded)
https://app.getmateo.com/conversations/new?channel_id=9646acea-f031-4522-ae7f-03932e42e619&handle=%2B4915212345678
Single Recipient - Phone without +
https://app.getmateo.com/conversations/new?channel_id=9646acea-f031-4522-ae7f-03932e42e619&handle=4915212345678
Single Recipient - Email (Encoded)
https://app.getmateo.com/conversations/new?channel_id=abc123-def456-789&handle=kunde%40beispiel.de
Single Recipient - Handle with Spaces (Encoded)
https://app.getmateo.com/conversations/new?channel_id=abc123-def456-789&handle=my%20custom%20handle
Multiple Recipients - Broadcast Mode (2 recipients)
https://app.getmateo.com/conversations/new?channel_id=9646acea-f031-4522-ae7f-03932e42e619&handle=%2B4915212345678,%2B4917612398765
Multiple Recipients - Broadcast Mode (3 recipients)
https://app.getmateo.com/conversations/new?channel_id=9646acea-f031-4522-ae7f-03932e42e619&handle=%2B4915212345678,%2B4917612398765,%2B4916023456789
https://app.getmateo.com/conversations/new?channel_id=9646acea-f031-4522-ae7f-03932e42e619&handle=%2B4915212345678,4917612398765,004916023456789
Multiple Recipients - Emails (5 recipients)
https://app.getmateo.com/conversations/new?channel_id=abc123-def456-789&handle=kunde1%40beispiel.de,kunde2%40beispiel.de,support%40firma.com,info%40test.de,kontakt%40company.de
Multiple Recipients - With Spaces (Encoded)
https://app.getmateo.com/conversations/new?channel_id=abc123-def456-789&handle=user%20one,user%20two,user%20three
β Common Mistakes
Donβt use unencoded special characters:
β handle=+4915212345678,+4917612398765 (+ will be lost)
β handle=kunde@beispiel.de (may break the URL)
β handle=my custom handle (spaces will break the URL)
Always encode:
β
handle=%2B4915212345678,%2B4917612398765
β
handle=kunde%40beispiel.de
β
handle=my%20custom%20handle