Class WebTrigger
Namespace: Casewhere.Models
Assembly: Casewhere.Models.dll
Represents a web trigger entity. With web triggers, you can expose a Web API endpoint for your external systems to trigger a workflow in Casewhere. Using web triggers is one of the most popular ways to integrate other systems with Casewhere.
public class WebTrigger : Entity, IIdentity
Inheritance
object ← Entity ← WebTrigger
Implements
IIdentity
Inherited Members
Entity.GetResourceName(), Entity.Id, Entity.Version, Entity.CreatedBy, Entity.CreatedAt, Entity.ModifiedBy, Entity.ModifiedAt, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()
Extension Methods
ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<WebTrigger>(WebTrigger)
Constructors
WebTrigger()
public WebTrigger()
Properties
AccessRuleId
public Guid AccessRuleId { get; set; }
Property Value
Description
Gets or sets the description of the web trigger.
public string Description { get; set; }
Property Value
EnableAccessibleFromWorkerSite
public bool EnableAccessibleFromWorkerSite { get; set; }
Property Value
EnableRespondUsingWorkflowOutput
public bool EnableRespondUsingWorkflowOutput { get; set; }
Property Value
EnableRunImmediately
public bool EnableRunImmediately { get; set; }
Property Value
FormatterExpression
Gets or sets the formatter expression of the web trigger.
public string FormatterExpression { get; set; }
Property Value
HttpMethod
public string HttpMethod { get; set; }
Property Value
IsActive
Gets or sets a value indicating whether the web trigger is active.
public bool IsActive { get; set; }
Property Value
IsLocked
public bool IsLocked { get; set; }
Property Value
Name
Gets or sets the name of the web trigger. The web trigger name must be unique. It's possible to execute a web trigger using its name through the endpoint https://{your-casewhere-api-domain}/external/v0.1/{web-trigger-name}
public string Name { get; set; }
Property Value
Priority
Gets or sets the priority of the web trigger.
public WorkflowPriority Priority { get; set; }
Property Value
ProcessId
Gets or sets the process ID associated with the web trigger. The process in which the triggered workflow will run. A new case is created every time Casewhere executes a web trigger. Casewhere.Models.Process
public Guid ProcessId { get; set; }
Property Value
ProductId
Gets or sets the product ID associated with the web trigger. The ID of the Product package that the worker site belongs to.
public Guid ProductId { get; set; }
Property Value
Tags
public IList<string> Tags { get; set; }
Property Value
TriggerRule
Gets or sets the trigger rule of the web trigger. To validate the web request and determine where or not a workflow should be executed. If the validation fails, Casewhere will respond with status code 400.
public string TriggerRule { get; set; }
Property Value
TriggerRuleType
public TriggerRuleType TriggerRuleType { get; set; }
Property Value
Uris
public IReadOnlyList<string> Uris { get; set; }
Property Value
WorkflowDefinitionId
Gets or sets the workflow definition ID associated with the web trigger. Casewhere.Models.WorkflowDefinition
public Guid WorkflowDefinitionId { get; set; }
Property Value
Methods
GetResourceName()
Gets the display name of the entity.
public override string GetResourceName()
Returns
The display name of the entity.