# TriggerOut

Read model echoed by GET and returned by PUT.

Only the fields belonging to the active trigger `type` are populated; all
others are `null`. When `active` is false, `type` is `null` too and every
other field is empty — that is the shape of a workflow with no trigger.

Type: object

Fields typed as another model are documented on that model's page; fetch it before filling the field.

| Field | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- |
| `active` | boolean | no | Whether a trigger is currently set and enabled. When false, every other field is null and the workflow runs only on demand. | default: `false` |
| `type` | string, nullable | no | Which kind of trigger is set, and therefore which fields below are populated. Null when `active` is false. | one of: `"time"`, `"workflow_finished"`, `"form_submission"` |
| `frequency` | string, nullable | no | time triggers only: `minutes`, `hourly`, `daily`, `weekly` or `monthly`. Null when the trigger was set with a raw `cron`. |  |
| `every` | integer, nullable | no | time triggers only: the interval within `frequency` — minutes: 15 or 30; hourly: 1, 2, 4, 6, 8 or 12. |  |
| `time` | string, nullable | no | time triggers only: `HH:MM` in `timezone`, for daily, weekly and monthly frequencies. The minute is always `:00`. |  |
| `weekday` | string or array of string, nullable | no | time triggers, weekly only: a day name (`sunday`..`saturday`), or a list of them when the schedule repeats on several days. |  |
| `day_of_month` | integer or string, nullable | no | time triggers, monthly only: the day of the month (1..31), or the string `last` for the final day of each month. |  |
| `cron` | string, nullable | no | time triggers only: the effective five-field cron expression the schedule resolved to. Always present for a time trigger, whether it was created from `cron` or from the friendly fields. |  |
| `timezone` | string, nullable | no | time triggers only: the IANA timezone the schedule is evaluated in (for example `Europe/Madrid`). |  |
| `after_workflow_id` | string, nullable | no | workflow_finished triggers only: the id of the parent workflow whose completion starts this one. |  |
| `form_id` | string, nullable | no | form_submission triggers only: the id of the form whose new responses start this workflow. |  |

## Used by

- [DELETE /rest/beta/workflows/{id}/trigger](https://api.sheetgo.com/rest/reference/triggers.md#delete-rest-beta-workflows-id-trigger)
- [GET /rest/beta/workflows/{id}/trigger](https://api.sheetgo.com/rest/reference/triggers.md#get-rest-beta-workflows-id-trigger)
- [PUT /rest/beta/workflows/{id}/trigger](https://api.sheetgo.com/rest/reference/triggers.md#put-rest-beta-workflows-id-trigger)

---

More: start page https://api.sheetgo.com/rest/reference.md, everything in one file https://api.sheetgo.com/rest/llms-full.txt, OpenAPI https://api.sheetgo.com/rest/openapi.json.