cancelEvent( )

Cancels any remaining actions for a trigger and external entity.

Events are not cancelable by default. To make an event cancelable, you must first pass an externalEntityId and the applicable triggerKey to reportEvent(). When you call cancelEvent() with the same externalEntityId and triggerKey, the event is canceled, as are all other events that share the externalEntityId and triggerKey.

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
Manage Your App
Read site, business, and email details
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
triggerKeystringRequired

Trigger key whose event you want to cancel. For example, form_submitted or invoice_due.

externalEntityIdstringRequired

ID of the related resource in GUID format. For example, fc81a355-3429-50fc-a4c7-def486e828f3.

Typically, this ID is defined in your system, but you can also use any Wix resource GUID, such as contact ID, member ID, or invoice ID. See Choose the right externalEntityId for more information.

JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?