core-utils
    Preparing search index...

    Interface CancelRequest

    Request parameters for cancelling a previously triggered workflow.

    Cancels any queued workflow runs associated with the given workflowKey / cancellationKey pair. The cancellationKey must match the one passed in TriggerBody.cancellationKey when the workflow was triggered.

    https://docs.knock.app/send-notifications/canceling-workflows

    interface CancelRequest {
        cancellationKey: string;
        dryRun?: boolean;
        recipients?: string[];
        workflowKey: string;
    }
    Index

    Properties

    cancellationKey dryRun? recipients? workflowKey

    Properties

    cancellationKey: string

    The cancellation key used when originally triggering the workflow.

    TriggerBody.cancellationKey

    dryRun?: boolean

    If true, the cancellation will not be sent, but the request will be validated and logged.

    recipients?: string[]

    Scope the cancellation to specific user IDs. If omitted, cancels for all recipients associated with the cancellationKey.

    workflowKey: string

    Workflow key.

    Settings

    Member Visibility

    On This Page

    Properties