Create a subscription
Click New in the Subscriptions overview. A new, empty subscription opens with three cards; this page covers the first one, Details. It answers the question when should this run?
The Details card
Trigger identifier (required)
The code of the event you want to listen for, for example
$invoicing_invoice_finalized. It's a free-text box, so it has to be typed exactly
right — a typo means the subscription simply never fires.
The Event types page lists the identifiers you can use, grouped by area, and explains how the ones for your own objects are built up.
Type the complete identifier, including the last part (…_finalized, …_add,
…_update). Leaving the last part off works in some cases and silently fails in others,
so the whole identifier is always the safe choice.
Name
A short label so you can recognise the subscription in the overview — "Send finalised invoice to Exact Online". Optional, but very much worth filling in: the overview shows identifiers, and several subscriptions often share one.
Trigger type (required)
The kind of event. A new subscription starts on Generic, so this is one to set deliberately. Pick the one that matches the last part of your trigger identifier:
| Trigger type | Use it for identifiers ending in |
|---|---|
| Create | _add, _added, _create, _created |
| Update | _change, _changed, _update, _updated |
| Delete | _delete, _deleted, _detach, _detached, _remove, _removed |
| Processed | _processed |
| Generic | everything else — including _finalized, _cancel, _split, the port-visit events, and incoming webhooks |
| Hangfire | scheduled jobs, where the identifier is the job's ID |
Getting this wrong is the most common reason a subscription never runs, so check it against the Event types page — the type is listed there for every event.
When the trigger type is Update, SHIPM8 only runs the subscription if the event carries both the old and the new version of the record. Events that don't carry a "before" picture are skipped for Update subscriptions.
Starts on / Ends on
An optional window in which the subscription is active. Outside it, the subscription is ignored — the event still happens, it just doesn't match.
Both are dates:
- Leave both empty for a subscription that's always on.
- Set Ends on to switch a subscription off from a certain date without deleting it.
- Set Starts on to prepare an automation now and have it begin later.
This is also the tidy way to pause an automation: put an Ends on date in the past rather than deleting the subscription, and you keep the configuration for later.
Saving
Click Save. Trigger identifier and trigger type are required; the page marks them in red if they're missing. After saving, the subscription gets an ID and you can add conditions and actions.
Editing and deleting
An existing subscription opens read-only.
- Edit unlocks all three cards. Change what you need and click Save.
- The ⋮ menu next to Save holds Delete. Deleting a subscription also removes all of its event actions, and you're asked to confirm first.