SavvyCal API
Endpoints
Resources
Webhooks
SavvyCal API
Home Help

Workflow Rule

A representation of a workflow rule.

Properties

This resource includes the following properties:

Property Type Description
id string The rule ID.
trigger_type string The trigger for the rule.
trigger_offset_amount number The amount of time from the trigger point.
trigger_offset_unit string The units for the offset amount.
trigger_offset_direction string The direction of the offset.
created_at string The ISO-8601 timestamp when the rule was created.
actions array of Action An array of workflow actions.

Example

Here is an example representation of this resource:

{
"id": "wrule_01ED74HMFGVZ92YVCWTD8Y8H6X",
"trigger_type": "event_started",
"trigger_offset_amount": 10,
"trigger_offset_unit": "minutes",
"trigger_offset_direction": "before",
"created_at": "2021-01-01T10:00:00Z",
"actions": [{
"id": "waction_01ED74HMFGVZ92YVCWTD8Y8H6X",
"type": "trigger_automation",
"properties": {
"description": "Post in Slack"
},
"created_at": "2021-01-01T10:00:00Z"
}]
}