reportEvent( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Reports an event and activates site automations with the specified trigger key.

Only the app that created a trigger can report events for it. This means other apps can't report events for your triggers, and you can't report events for another app's triggers.

If your app supports canceling events, externalEntityId must be provided. externalEntityId is required when calling cancelEvent().

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Your App
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
triggerKeystringRequired

Trigger key as defined in your app's trigger configuration in the app dashboard. For example, form_submitted or invoice_due.


optionsReportEventOptions
Returns
Return Type:Promise<ReportEventResponse>
Did this help?