External events
Documentation coming soon
External events are already available. The reference for the Events and Webhooks endpoints, along with detailed tutorials, will be published shortly.
The ShopiMind API lets you trigger marketing automation scenarios from any third-party system — POS, ERP, survey platform, carrier, in-house scheduler — via custom events. This is the recommended path to connect a business event to a ShopiMind customer journey without coupling systems.
How it works
The integration takes three steps:
- Declare an event type on the ShopiMind side. You define its
code_name(used in the trigger URL), the payload structure (metaData/customData), and the expected target (a contact or a visitor). - Fire an instance of that event from your third-party tool, by POSTing to the
triggerEventendpoint with the event'scode_nameand the payload defined in step 1. - Configure the marketing automation scenarios that react to that event from the ShopiMind dashboard (filters, conditions, content).
Each emission immediately activates the scenarios subscribed to the code_name. The target (contact or visitor) is resolved server-side from the identifiers supplied in the payload (email, id_customer, id_contact).
Typical use cases
- POS — fire a "physical store purchase" event to unify post-purchase workflows across web and retail (recovery, loyalty, satisfaction).
- Survey tool — fire an "NPS score received" event to trigger automatic recovery on detractors and an advocacy scenario on promoters.
- Carrier webhook — fire a "delivered" event to trigger a review request 2 to 4 days after actual receipt (vs. shipping).
- ERP — fire a "subscription renewed" or "unpaid invoice detected" event to wire marketing follow-up to your operational events.
See also the use cases for detailed examples combining external events and custom data.