Get your data out of Allmoxy: triggers, webhooks, Zapier and the API
Four ways to get Allmoxy data into other tools: a report export, triggers, webhooks, Zapier and the API, plus how to build a dashboard on top of them.
There are four ways to get your data out of Allmoxy, from no-code to full control. Export a report to CSV when you need a list today. Set up a trigger when you want records sent somewhere automatically as things happen, by email (with your exporter files attached) or by webhook to another app. Connect Zapier when you want those events to land in a spreadsheet or another service without a developer. Use the API when a developer is building something on your data. This article walks through each, says which events you can react to, and ends with how shops build dashboards on top.
Applies to: every Allmoxy shop. Triggers live under Settings > Operations > Triggers, Zapier and the API under Settings > Integrations, each behind its own permission.
In this article
- Start with a report export
- Send records out automatically with a trigger
- Level up with webhooks
- Connect Zapier
- For developers: the API
- Build a dashboard
- Get help choosing
- Things to know
Start with a report export
The simplest route, and often enough: open the report, set the filters, click Export and choose CSV. The file holds every row that matches your filters, usually with more columns than the screen, and opens in Excel or another spreadsheet, where a pivot table or a chart is a few clicks away. Repeat it each week with a saved search. Steps and what each report's file holds: Export a report to CSV or PDF.
If what you need is a list of orders, start with Reports > Production > Orders: it can be dated by entered, ordered or shipped date, filtered by status, company and tags, and exported one row per order or per line item.
Send records out automatically with a trigger
A trigger watches for one event and runs one action. Events include New Company Created, New Company Contact Created, New Individual Created, Order Status Changes To (pick Ordered to catch new orders), Ship Date Modified, Payment Made, Invoice created, Order Past Due By, Note Created On, New Product Created and New Supply Created. Actions include sending an email, a text, an announcement or a task, adding or removing tags, and calling a webhook.
For getting data out, two actions matter:
- Send an email can attach the order's output pages and the files from your exporters, so an order's cut list or the CSV your other software reads arrives in an inbox (or a shared mailbox that another tool watches) the moment the order is verified. Exporters: Exporters: send part data to your machines and software.
- Send a web request (webhook), next section.
Setting up a trigger, with examples: How triggers work and how to build one.
Level up with webhooks
A webhook sends the event's data straight to a web address you give, as the event happens, so a task tool, a database or a no-code service can react in real time. Follow your chosen app's instructions to get its webhook URL, create a trigger for the event you want with the webhook action, and paste the URL in; the app, or a no-code tool in between, then picks out the fields it needs.
The event decides what is sent:
- A New Company Created webhook carries the company's details.
- An Order Status Changes To webhook carries the order: its products with their options, supplies, totals, dates, addresses and tags, so a status change to Ordered or Shipped can update a board or a spreadsheet row with the whole order.
Every call is recorded in Reports > Managerial > Trigger Call Log with what was sent and the reply, which is where to look when the other end didn't get it; a failed call is not retried, so the other app needs to be reachable. Setup, the request formats and an example: Send order data to another app with a webhook.
Connect Zapier
Zapier moves data between Allmoxy and hundreds of other apps without code, using its own connection (Settings > Integrations > Zapier) rather than your triggers. A Zap starts from an Allmoxy event (a new company, an order status change, a payment and so on) and writes it wherever you like: a row in a spreadsheet, a card in a task tool, a message to your team. If you prefer to keep things simple, this is the route to a live spreadsheet of orders. Getting connected and a first Zap: Connect Allmoxy to Zapier and build your first Zap; what each event sends: Zapier triggers and the data each one sends: reference.
For developers: the API
If you have a developer and want full control, the API gives programmatic access to your Allmoxy data, including every report: each report has its own address and returns the same rows the screen does, with the same filters. Two things to set up: the integration must be granted each report it reads in its API settings, and the contact it runs as needs View reports plus those reports' permissions, the same as a person. With that, a developer can build dashboards, feed an enterprise reporting tool, or build custom applications on your manufacturing data.
The API comes with a sandbox (test) site, so your developer can build against a copy before touching live data, and the hosted API reference describes every call. Ask your Customer Success Manager to get set up, then follow Set up API access: Client ID, contact keys and test tokens.
Build a dashboard
A dashboard is the last step, not the first. Get the data flowing first, by export, trigger, Zapier or the API, into a spreadsheet, a database or a dashboard tool, and only then design the charts; a dashboard fed by a process that isn't running smoothly won't tell you anything. Shops have built theirs in spreadsheets and in dedicated dashboard tools; which is right depends on what you want to see and who maintains it. Start with the three numbers you check every Monday, feed those, and grow it from there.
Get help choosing
Not sure which approach fits? Reach out to your Customer Success Manager. They can walk you through the options, connect you with the API sandbox and documentation, and bring in our implementation team when you need an exporter or a custom export built to match the format another system expects.
Things to know
- Export first. A CSV from the right report answers most questions, and the file usually has more than the screen.
- A trigger reacts to one event with one action. The event names above are the real ones; there is no "New Order Created" event, so use Order Status Changes To with Ordered.
- The event decides the webhook's fields. A company event carries the company; an order status event carries the whole order.
- Check the Trigger Call Log when a webhook or email didn't arrive. Calls are logged, not retried.
- Zapier is its own connection, separate from triggers, under Settings > Integrations > Zapier.
- The API needs the report granted to the integration as well as the permissions on the contact it runs as.