reportEvent( )

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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Set Up Automations
Manage Your App
Read site, business, and email details
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>
JavaScript
Errors
400Invalid Argument

There is 1 error with this status code.

428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?