> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSWorkflowTrigger

> Carrier object for WorkflowTrigger.

Carrier object for WorkflowTrigger.

## Constructors

### NSWorkflowTrigger()

```crmscript theme={null}
NSWorkflowTrigger
```

Initializes a new instance of the NSWorkflowTrigger class.

## Methods

## GetWorkflowTriggerId()

Gets the primary key (ID) for the WorkflowTrigger.

```crmscript theme={null}
Integer GetWorkflowTriggerId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - WorkflowTrigger Id.

## SetWorkflowTriggerId(Integer)

Sets the primary key (ID) for the WorkflowTrigger.

```crmscript theme={null}
Void SetWorkflowTriggerId(Integer workflowTriggerId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## GetWorkflowId()

Gets the ID of the workflow this trigger belongs to.

```crmscript theme={null}
Integer GetWorkflowId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Workflow ID.

## SetWorkflowId(Integer)

Sets the ID of the workflow this trigger belongs to.

```crmscript theme={null}
Void SetWorkflowId(Integer workflowId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## GetTriggerType()

Gets the type of trigger.

```crmscript theme={null}
NSWorkflowTriggerType GetTriggerType()
```

**Returns:** [CRMScript.NetServer.NSWorkflowTriggerType](CRMScript.NetServer.NSWorkflowTriggerType) - Trigger type.

## SetTriggerType(NSWorkflowTriggerType)

Sets the type of trigger.

```crmscript theme={null}
Void SetTriggerType(NSWorkflowTriggerType triggerType)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## GetRestrictionGroups()

Gets the restrictions (can be multiple groups) that make up the trigger criteria.

```crmscript theme={null}
NSArchiveRestrictionGroup[] GetRestrictionGroups()
```

**Returns:** [CRMScript.NetServer.NSArchiveRestrictionGroup](CRMScript.NetServer.NSArchiveRestrictionGroup)\[] - Array of restriction groups.

## SetRestrictionGroups(NSArchiveRestrictionGroup\[])

Sets the restrictions that make up the trigger criteria.

```crmscript theme={null}
Void SetRestrictionGroups(NSArchiveRestrictionGroup[] restrictionGroups)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)


## Related topics

- [NSWorkflowAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSWorkflowAgent.md)
- [Delete Workflow Trigger](/en/api/reference/restful/agent/workflow_agent/delete-workflow-trigger.md)
- [workflow_trigger table](/en/database/tables/workflow-trigger.md)
- [Save Workflow Trigger](/en/api/reference/restful/agent/workflow_agent/save-workflow-trigger.md)
- [Get Workflow Trigger](/en/api/reference/restful/agent/workflow_agent/get-workflow-trigger.md)
- [Create Default Workflow Trigger](/en/api/reference/restful/agent/workflow_agent/create-default-workflow-trigger.md)