This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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
.
Trigger key whose event you want to cancel. For example, form_submitted or invoice_due.
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.