The payload for creating a transition in a workflow. Can be DIRECTED, GLOBAL, SELF-LOOPED, GLOBAL LOOPED

interface TransitionPayload {
    actions?: RulePayload[];
    conditions?: ConditionGroupPayload;
    customIssueEventId?: string;
    description?: string;
    from?: FromLayoutPayload[];
    id?: number;
    name?: string;
    properties?: {
        [key: string]: string;
    };
    to?: ToLayoutPayload;
    transitionScreen?: RulePayload;
    triggers?: RulePayload[];
    type?: "global" | "initial" | "directed";
    validators?: RulePayload[];
}

Properties

actions?: RulePayload[]

The actions that are performed when the transition is made

The payload for creating a condition group in a workflow

customIssueEventId?: string

Mechanism in Jira for triggering certain actions, like notifications, automations, etc. Unless a custom notification scheme is configure, it's better not to provide any value here

description?: string

The description of the transition

The statuses that the transition can be made from

id?: number

The id of the transition

name?: string

The name of the transition

properties?: {
    [key: string]: string;
}

The properties of the transition

Type declaration

  • [key: string]: string

    The properties of the transition

The payload for the layout details for the destination end of a transition

transitionScreen?: RulePayload

The payload for creating rules in a workflow

triggers?: RulePayload[]

The triggers that are performed when the transition is made

type?: "global" | "initial" | "directed"

The type of the transition

validators?: RulePayload[]

The validators that are performed when the transition is made