Skip to main content

WorkflowDefinition

Struct WorkflowDefinition 

Source
pub struct WorkflowDefinition {
Show 27 fields pub id: Option<String>, pub created_at: Option<DateTime<Utc>>, pub updated_at: Option<DateTime<Utc>>, pub archived_at: Option<DateTime<Utc>>, pub name: Option<String>, pub group_name: Option<String>, pub description: Option<String>, pub type: Option<WorkflowType>, pub trigger: Option<WorkflowTrigger>, pub trigger_type: Option<WorkflowTriggerType>, pub conditions: Option<Value>, pub enabled: Option<bool>, pub team: Option<Team>, pub creator: Option<User>, pub activities: Option<Value>, pub sort_order: Option<String>, pub last_executed_at: Option<DateTime<Utc>>, pub last_updated_by: Option<User>, pub label: Option<IssueLabel>, pub cycle: Option<Cycle>, pub user: Option<User>, pub project: Option<Project>, pub initiative: Option<Initiative>, pub custom_view: Option<CustomView>, pub context_view_type: Option<ContextViewType>, pub user_context_view_type: Option<UserContextViewType>, pub slug_id: Option<String>,
}
Expand description

An automation workflow definition that executes a set of activities when triggered by specific events. Workflows can be scoped to a team, project, cycle, label, custom view, initiative, or user context. They are triggered by entity changes (e.g., issue status change, new comment) and can include conditions that filter which events actually execute the workflow. Activities define the actions taken, such as updating issue properties, sending notifications, or posting to Slack.

Fields§

§id: Option<String>

The unique identifier of the entity.

§created_at: Option<DateTime<Utc>>

The time at which the entity was created.

§updated_at: Option<DateTime<Utc>>

The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn’t been updated after creation.

§archived_at: Option<DateTime<Utc>>

The time at which the entity was archived. Null if the entity has not been archived.

§name: Option<String>

The name of the workflow.

§group_name: Option<String>

The name of the group that the workflow belongs to.

§description: Option<String>

The description of the workflow.

§type: Option<WorkflowType>

The type of the workflow, such as custom automation, SLA, or auto-close.

§trigger: Option<WorkflowTrigger>

The event that triggers the workflow, such as entity creation, update, or a specific state change.

§trigger_type: Option<WorkflowTriggerType>

The entity type that triggers this workflow, such as Issue, Project, or Release.

§conditions: Option<Value>

The filter conditions that must match for the workflow to execute. When null, the workflow triggers on all matching events.

§enabled: Option<bool>

Whether the workflow is enabled and will execute when its trigger conditions are met.

§team: Option<Team>

The team associated with the workflow. If not set, the workflow is associated with the entire workspace.

§creator: Option<User>

The user who created the workflow.

§activities: Option<Value>

The ordered list of activities (actions) that are executed when the workflow triggers, such as updating issue properties, sending notifications, or calling webhooks.

§sort_order: Option<String>

The sort order of the workflow definition within its siblings.

§last_executed_at: Option<DateTime<Utc>>

The date and time when the workflow was last triggered and executed. Null if the workflow has never been executed.

§last_updated_by: Option<User>

The user who last updated the workflow.

§label: Option<IssueLabel>

The contextual label view associated with the workflow.

§cycle: Option<Cycle>

The contextual cycle view associated with the workflow.

§user: Option<User>

The contextual user view associated with the workflow.

§project: Option<Project>

The contextual project view associated with the workflow.

§initiative: Option<Initiative>

The contextual initiative view associated with the workflow.

§custom_view: Option<CustomView>

The context custom view associated with the workflow.

§context_view_type: Option<ContextViewType>

The type of view to which this workflow’s context is associated with.

§user_context_view_type: Option<UserContextViewType>

The type of user view to which this workflow’s context is associated with.

§slug_id: Option<String>

The workflow definition’s unique URL slug.

Trait Implementations§

Source§

impl Clone for WorkflowDefinition

Source§

fn clone(&self) -> WorkflowDefinition

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for WorkflowDefinition

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for WorkflowDefinition

Source§

fn default() -> WorkflowDefinition

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for WorkflowDefinition

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl GraphQLFields for WorkflowDefinition

Source§

type FullType = WorkflowDefinition

The full generated type this implementation validates against.
Source§

fn selection() -> String

Return the GraphQL field selection string for this type. Read more
Source§

impl Serialize for WorkflowDefinition

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> FieldCompatible<T> for T