About the Triggered Events API

The Triggered Events API allows you to turn events in your service into triggers. Using this API, you can report events to Wix. A reported event becomes a trigger that site owners can use when they create their site automations.

With the Triggered Events API, you can:

• Report events to trigger site automations.
• Bulk report multiple events simultaneously to activate corresponding automations.
• Cancel and bulk cancel events to stop any remaining actions associated with a trigger and external entities.
• Run an automation directly, without reporting an event.
• Test an automation, including an unpublished draft, before publishing it.
• Rerun a previous activation to retry one that failed.

When you report an event, Wix accepts it and processes it asynchronously. A successful response means the event was accepted for processing, not that the automations have finished running.

Run automations directly

In addition to reporting events, you can run automations directly:

• Run an automation: Activate an automation manually when no triggering event occurs in your system. For example, run an automation that sends a booking confirmation when a customer books by phone instead of online. Identify the automation by its ID, which you can retrieve from the Automations API, or, for a preinstalled automation, by its app ID and component ID.
• Test an automation: Run an automation in test mode to verify its behavior before publishing. Test mode runs the automation and its actions for real, can run an unpublished draft automation, and skips any configured delays so you see the results immediately.
• Rerun an activation: Retry a previous activation, reusing its original payload, after you've resolved whatever caused it to fail. A rerun creates a new activation.

Before you begin

It's important to note the following points before starting to code:

• You must add a trigger to your app and define its payload schema in the app dashboard before you report an event.
• Only the app that the trigger belongs to can report the event.
• Make sure you know your trigger key. You can find this by selecting your trigger in the app dashboard.

Use cases

• Report an event and cancel it when it's no longer relevant
• Bulk report events and later bulk cancel them
• Run an automation when no triggering event occurs
• Retry a failed activation

Terminology

• Trigger Key: A unique string that identifies the trigger.
• External Entity ID: A GUID that identifies the related resource for an event, such as a contact or session ID. This allows you to identify the specific case for which the event was reported. See Reporting and Canceling Events for more information.
• Idempotency: A mechanism to ensure that multiple identical requests don't cause unnecessary automation activation. You pass in a unique idempotency key for the event when you report it. If an event with the same idempotency key is reported multiple times, Wix ignores it for the duration of time that you define.