> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

## Resource: Introduction

## Article: Introduction

## Article Link: https://dev.wix.com/docs/api-reference/business-management/automations/triggers/triggered-events/introduction.md

## Article Content:

# About the Triggered Events API

> **Note:** You must have an app in the [Custom Apps Page](https://manage.wix.com/studio/custom-apps) to use this API. If you're using [Wix Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless.md) or developing a site, this API isn't applicable.

The Triggered Events API allows you to turn events in your service into [triggers](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/about-triggers.md). 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](https://dev.wix.com/docs/rest/business-management/automations/introduction.md).

With the Triggered Events API, you can:

- [Report events](https://dev.wix.com/docs/rest/business-management/automations/triggers/triggered-events/report-event.md) to trigger site automations.
- [Bulk report](https://dev.wix.com/docs/rest/business-management/automations/triggers/triggered-events/bulk-report-event.md) multiple events simultaneously to activate corresponding automations.
- [Cancel](https://dev.wix.com/docs/rest/business-management/automations/triggers/triggered-events/cancel-event.md) and [bulk cancel](https://dev.wix.com/docs/rest/business-management/automations/triggers/triggered-events/bulk-cancel-event.md) events to stop any remaining actions associated with a trigger and external entities.

## Before you begin

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

- You must [add a trigger](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/add-an-automations-trigger-extension.md) 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](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fautomations-dev-center).

## Use cases

- Report an invoice overdue event, then cancel it when the customer pays the invoice.
- If a customer has booked multiple sessions then canceled all of them, you can use `Bulk Cancel` to cancel all reminders for those sessions.

## 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](https://dev.wix.com/docs/rest/business-management/automations/triggers/triggered-events/reporting-and-canceling-events.md) 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.

<!-- Add the following in a separate article titled Sample Flows - I'll come back to this later

# Activation Trigger Events: Sample Use Cases and Flows

This article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping-off point as you plan your app's implementation.

### Report an Event and Subsequently Cancel It

In this scenario, you will report an event and then cancel it if certain conditions are met. This is useful for situations where an event might need to be retracted or undone based on specific criteria.

To report an event and subsequently cancel it:

1. Call the Report Event endpoint with the `triggerKey` and `externalEntityId` to report the event. This activates the site automations associated with the specified trigger key.
2. If the conditions for canceling the event are met, call the Cancel Event endpoint with the same `triggerKey` and `externalEntityId`. This cancels any remaining actions for the event.

### Bulk Report Multiple Events and Then Bulk Cancel Them

In this scenario, you will bulk report multiple events and then bulk cancel them if they are no longer relevant. This is useful for managing multiple events efficiently.

To bulk report multiple events and then bulk cancel them:

1. Call the Bulk Report Event endpoint with the `triggerKey` to report multiple events. This activates the site automations associated with the specified trigger key for all the events.
2. If the events are no longer relevant, call the Bulk Cancel Event endpoint with the same `triggerKey` and the relevant `externalEntityId`s. This cancels any remaining actions for all the specified events.
-->