Webhooks
Webhooks send a short message to an address of yours when something happens on the floor. Your ERP, a chat channel or your own tool can react at once, without asking Floormode every few minutes.
You will find them in Settings → Integrations → Webhooks. They are part of the Enterprise plan, together with the REST API.
On this page
Section titled “On this page”- What can send a message
- Add an address
- The signing secret
- Test, switch off, delete
- When an address keeps failing
- See also
What can send a message
Section titled “What can send a message”Choose the events for each address:
| Event | Sent when |
|---|---|
| Label bought | A shipping label was bought for a shipment |
| Packing finished | A pack job was verified and handed on for fulfillment |
| Order fulfilled | Floormode’s fulfillment reached Shopify |
| Parcel delivered | The carrier delivered a shipment. Sent once per shipment |
| Delivery problem | The carrier reported a problem with a shipment, such as a failed delivery attempt or a return to sender. Sent again if a new problem follows after the parcel was moving again |
| Count found a difference | A submitted count does not match the stock on record |
| Order put on hold | A hold became active on an order |
A message carries ids, short ids, order and warehouse names, statuses and counts. It never carries a customer’s name, email, address or phone. Your system reads the details through the REST API with its own access.
Add an address
Section titled “Add an address”Click Add an address, paste an https:// address and tick the events. You can add up to 10 addresses.
Floormode only sends to public addresses. An address on a private or local network is refused, before it is saved and again before every message.
The signing secret
Section titled “The signing secret”Right after you add an address, Floormode shows its signing secret. Copy it now: it will not be shown again. Your system uses it to check that each message really came from Floormode. Every message carries a signature made with this secret; the technical details are in the REST API reference.
New secret makes a new one. Messages sent from then on use it. A message that was already on its way can still arrive with the old secret, so let your system accept both for five minutes, then remove the old one.
Test, switch off, delete
Section titled “Test, switch off, delete”- Send test sends a test message. The list below the address shows each message, whether it arrived and what the address answered.
- Send switches an address on or off. While it is off, nothing is sent.
- Delete removes the address. Messages still waiting are not sent.
When an address keeps failing
Section titled “When an address keeps failing”A message that does not get through is tried again for a while, on growing intervals. While an address keeps failing, Floormode tries it once per interval instead of sending every waiting message.
After 20 messages in a row did not arrive, Floormode switches the address off and says why. Fix the receiving side, then switch it on again. Test messages never count toward this.
See also
Section titled “See also”- REST API — read the details a message points to.
- Integration health — the other apps Floormode talks to.
- Shopify Flow — the same events as triggers for your Flow workflows.