- Who can: any member of the brand
- Where in Cargofy: Studio › Integrations
What it is
The assistant sends email from Cargofy: a short notice to a warehouse or a consignee, or a list of your records as a file. It sends right away to the address you give. It cannot read your inbox.
What it can do
An email with a tender list from start to finish
A dispatcher’s conversation with the assistant and Cargofy’s real answers. The terms are in the Glossary. The tools behind each step are in the table at the end. Numbers and IDs on this page are examples.
1. Check that Cargofy can send
Can you send email from Cargofy for us?
The assistant lists your connections. The Cargofy connection (cargofy) is the one that sends from Cargofy, with the action send_email. Your Gmail or mailbox connections show up in the same list; the assistant does not use them here. Whether an email went out shows in the answer to the send: ok: true.
2. Send a short notice
Email demo@example.com with the subject “Demo: DEMO-EM-1 arrival”: the truck for DEMO-EM-1 arrives tomorrow at 14:00.
Cargofy answers ok: true with the recipient and the subject. The email comes from Cargofy’s address with your brand name as the sender, starts with “Hello!” and ends with the Cargofy footer.
3. Export a list to a file
Export our tenders in Matching to a file.
Cargofy saves the list as a JSON file in your account, for example shipment.json with 5 records, and answers with its file_id.
4. Email the file
Email that file to demo@example.com with the subject “Demo: DEMO-EM-2 tenders in Matching” and one line saying the list is attached.
Cargofy answers ok: true, the recipients and attachments: 1. The file arrives under its own name, shipment.json.
| Step | Tool | What the assistant sends |
|---|---|---|
| 1 | config-integrations-list | nothing; it reads integration_key, status and operations of each connection |
| 2 | notify-email | email, subject, body |
| 3 | entities-query | shipment with a filter on status_id 2 (“Matching”) and save_as_file: true |
| 4 | integration-cargofy-send_email | to, subject, body and attachment_file_ids with the file_id from step 3 |
Send a short notice
Let demo@example.com know that the unloading of DEMO-EM-3 is moved to Friday 10:00.
The assistant sends it with notify-email: one recipient, a subject and plain text. It needs no connection. Name the subject, or the assistant writes one. The answer repeats the recipient and the subject:
{ "ok": true, "to": "demo@example.com", "subject": "Demo: DEMO-EM-3 unloading" }Send to several recipients or with a file
Send the list of our locations as a file to demo@example.com.
For several recipients or an attachment the assistant uses integration-cargofy-send_email. Recipients go in to, separated by commas. Each recipient gets a separate email and does not see the others. This email has no “Hello!” line: it is your text with the Cargofy footer, in the language of your brand’s country.
An attachment is a file in your account. The assistant gets one by exporting a list with entities-query and save_as_file: tenders, trucks, locations, records of your data models. The file is JSON. If the list is too long, the export answer says truncated: true: narrow the list and export again. The answer to the send counts the attachments, for example attachments: 1.
Send from your own mailbox
The assistant also sees the email actions of mail integrations: Gmail (integration-google-send_email, integration-google-reply_email), Microsoft 365 Mail (integration-microsoft-send_email, integration-microsoft-reply_email) and Email (integration-mailbox-send_email). They send from your connected mailbox, not from Cargofy. Each works only when that integration is connected. Gmail and Microsoft 365 Mail take attachments; Email takes to, subject and body only. A reply needs the ID of the email you answer. Ask for the Cargofy email by name when you want it sent from Cargofy.
Check what is connected
Which integrations are connected?
config-integrations-list lists your connections with their status (“connected”, “error”, “needs_reauth”) and the actions each one runs. For an email from Cargofy, rely on the answer to the send: ok: true means it was accepted.
Glossary
The words of this page, what they mean in Cargofy and the name the assistant works with. Paste this table into the chat or add it to your assistant’s project knowledge.
| Term | Meaning | The assistant sees |
|---|---|---|
| Short notice | One email to one address, with a “Hello!” line | notify-email: email, subject, body |
| Cargofy email | An email from Cargofy to one or more addresses, with attachments | integration-cargofy-send_email: to (comma-separated), subject, body, attachment_file_ids |
| Cargofy connection | The integration that sends email from Cargofy | integration_key cargofy in config-integrations-list |
| Connection status | The state of a connection | status: “connected”, “error”, “needs_reauth” |
| Exported file | A list saved as a JSON file in your account | file_id from entities-query with save_as_file: true |
| Attachment | An exported file sent with the email | its file_id in attachment_file_ids, as a list |
| Your mailbox | Gmail, Microsoft 365 Mail or Email connected to Cargofy | integration-google-*, integration-microsoft-*, integration-mailbox-* |
| Connection | One connected account of an integration | connection_id, needed only when there are two |
Limits
- The assistant sends at once to any address you give.
ok: truemeans the email was accepted for sending, not delivered. Read the recipient and the text before you confirm the action in your assistant. - Put your contact details in the text so the recipient can reach you.
- Only a list exported to a file can be attached. A file from your computer or a document of a tender cannot.
- The assistant cannot read your inbox. To reply through Gmail or Microsoft 365 Mail, it needs the ID of the email you answer.