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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Set Up Automations
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>
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?