core-utils
    Preparing search index...

    Interface TriggerBody

    interface TriggerBody {
        actor?: RecipientRequest;
        cancellationKey?: string;
        data?: Record<string, unknown>;
        recipients: RecipientRequest[];
        workplaceId?: string;
    }
    Index

    Properties

    actor? cancellationKey? data? recipients workplaceId?

    Properties

    actor?: RecipientRequest

    The trigger actor.

    cancellationKey?: string

    An optional key used to reference a specific trigger request when issuing a cancellation request. You must provide it while triggering in order to enable subsequent cancellation and it should be unique across trigger requests to avoid unintentional cancellations.

    data?: Record<string, unknown>

    An optional map of data to pass into the trigger execution. Limited to 1024 bytes for each string and 10MB overall.

    recipients: RecipientRequest[]

    The recipients to trigger the workflow for. Limited to 1,000 recipients.

    workplaceId?: string

    The associated workplace ID.

    Settings

    Member Visibility

    On This Page

    Properties