bulkCancelEvent( )

Bulk cancels any remaining actions for a trigger and external entities.

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
function bulkCancelEvent(
  triggerKey: string,
  externalEntityIds: Array<string>,
): Promise<BulkCancelEventResponse>;
Method Parameters
triggerKeystringRequired

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

externalEntityIdsArray<string>Required

Repeated list of external_entity_id, representing the related resources' IDs.

Returns
Return Type:Promise<BulkCancelEventResponse>
JavaScript
import { activations } from "@wix/automations";

async function bulkCancelEvent(triggerKey, externalEntityIds) {
  const response = await activations.bulkCancelEvent(
    triggerKey,
    externalEntityIds,
  );
}
Errors

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

Did this help?