POST

Cancel Event


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 Report Event. When you call Cancel Event with the same externalEntityId and triggerKey, the event is canceled, as are all other events that share the externalEntityId and triggerKey. See Reporting and Canceling Events for more information.

You cannot try out this endpoint because it can be called only by the app that created the specified triggerKey. So please ignore the Try It Out button.

Authentication

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

Permissions
Manage Your App
Read site, business, and email details
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/automations/v1/events/cancel

Body Params
externalEntityIdstringRequiredformat GUID

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.


triggerKeystringRequiredminLength 1maxLength 100

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

Response Object
Returns an empty object.
Cancel Event Example 1
Request
cURL
curl POST https://www.wixapis.com/automations/v1/events/cancel \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>' \ -d '{ "triggerKey": "my_trigger", "externalEntityId": "16ef8c9c-413e-4d5f-b77d-8c67c3c8ae0c" }'
Response
JSON
{}
Errors

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

Did this help?