guild trigger

Automate agent execution. See Triggers for a full guide, or Event triggers, Schedule triggers, and API triggers for type-specific details. Each subcommand has its own section below, in alphabetical order. Commands that take a workspace use the default workspace when you leave out --workspace. If no default is set, run guild workspace select.

guild trigger list                           # List triggers in the default workspace
guild trigger create --type time --frequency DAILY --time 09:00 --agent <identifier> --name "Daily digest"
guild trigger update <trigger-id> --name "New name"   # Rename a trigger of any type, including API triggers
guild trigger deactivate <trigger-id>        # Deactivate a trigger

Pass --name to give a trigger a human-readable name. It’s optional on guild trigger create. To rename a trigger of any type, including an API trigger, run guild trigger update <trigger-id> --name "New name".

activate

Activate a trigger.

guild trigger activate <trigger-id>          # Activate a trigger

Argument	Description
`<trigger-id>`	The trigger ID.

create

Create a trigger in a workspace. --type and --agent are required. The agent must already be in the workspace. If it isn’t, run guild workspace agent add <identifier> first.

# Create a webhook trigger
guild trigger create --type webhook --integration slack --event app_mention --agent <identifier>

# Create a time trigger, with an optional human-readable name
guild trigger create --type time --frequency DAILY --time 09:00 --agent <identifier> --name "Daily digest"

# Create a time trigger from a cron expression
guild trigger create --type time --frequency CRON --cron-expression "0 9 * * 1-5" --cron-timezone America/New_York --agent <identifier>

# Create an API trigger
guild trigger create --type api --agent <identifier>

These options apply to every trigger type:

Option	Description
`--agent <identifier>`	Required. The agent to run, as a full name such as `owner~agent-name`, a name, or an ID.
`--name <name>`	The trigger name, unique within the workspace. Defaults to a name derived from the agent and type.
`--type <type>`	Required. The trigger type: `webhook`, `time`, or `api`.
`--workspace <id>`	The workspace ID or name.

Webhook trigger options

Use these options with --type webhook. --integration is required, and the integration must have webhooks configured.

Option	Description
`--action <action>`	The event action, such as `opened` or `created`.
`--event <event>`	The event type, such as `app_mention` or `issues`.
`--input <json>`	Agent input as a JSON object. Embed `{webhook_event}`, `{webhook_action}`, and `{webhook_payload}` placeholders in any string value. They’re replaced with the incoming webhook’s values when the trigger fires.
`--integration <name>`	Required. The integration name, such as `github`, `slack`, or `jira`.
`--service-config <json>`	Service-specific config as JSON.

Time trigger options

Use these options with --type time. --frequency is required. Each frequency accepts only certain options, and the command rejects any others:

HOURLY: --minutes-of-hour
DAILY: --time
WEEKLY: --time, --days-of-week
MONTHLY: --time, --days-of-month
CRON: --cron-expression (required), --cron-timezone

Option	Description
`--cron-expression <expression>`	A 5-field cron expression. Required with `--frequency CRON`.
`--cron-timezone <timezone>`	The IANA timezone for `--cron-expression`. Defaults to `UTC`.
`--days-of-month <days>`	Days of the month, comma-separated, such as `1,15,-1`.
`--days-of-week <days>`	Days of the week, comma-separated, such as `MONDAY,TUESDAY`.
`--frequency <freq>`	Required. `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`, or `CRON`.
`--input <json>`	Agent input as a JSON object.
`--minutes-of-hour <minutes>`	Minutes of the hour, comma-separated (`0`-`59`).
`--time <time>`	Time of day in `HH:MM` format.

API trigger options

--type api uses only the options shared by every trigger type. The CLI ignores webhook and time options for API triggers.

deactivate

Deactivate a trigger.

guild trigger deactivate <trigger-id>        # Deactivate a trigger

Argument	Description
`<trigger-id>`	The trigger ID.

get

Get a trigger’s details.

guild trigger get <trigger-id>               # Get trigger details

Argument	Description
`<trigger-id>`	The trigger ID.

list

List the triggers in a workspace.

guild trigger list                           # List triggers in the default workspace
guild trigger list --workspace <id>          # List triggers in a specific workspace
guild trigger list --limit 50 --offset 50    # Paginate

Option	Description
`--limit <number>`	The number of results to return. Defaults to `20`.
`--offset <number>`	The offset for pagination. Defaults to `0`.
`--workspace <id>`	The workspace ID or name.

sessions

List the sessions a trigger spawned.

guild trigger sessions <trigger-id>                       # List sessions spawned by a trigger
guild trigger sessions <trigger-id> --limit 50 --offset 50   # Paginate

Argument	Description
`<trigger-id>`	The trigger ID.

Option	Description
`--limit <number>`	The number of results to return. Defaults to `20`.
`--offset <number>`	The offset for pagination. Defaults to `0`.

update

Update a trigger. Only the options you pass change. You must pass at least one option.

guild trigger update <trigger-id> --time 10:00
guild trigger update <trigger-id> --name "New name"   # Rename a trigger of any type, including API triggers
guild trigger update <trigger-id> --frequency WEEKLY --time 09:00 --days-of-week MONDAY,THURSDAY
guild trigger update <trigger-id> --event issues --action opened   # Change a webhook trigger's event

When you pass --frequency, the same per-frequency rules as create apply.

Argument	Description
`<trigger-id>`	The trigger ID.

Option	Description
`--action <action>`	The event action, for webhook triggers.
`--cron-expression <expression>`	A 5-field cron expression, for `CRON` triggers.
`--cron-timezone <timezone>`	The IANA timezone for `--cron-expression`. Defaults to `UTC`.
`--days-of-month <days>`	Days of the month, comma-separated, for time triggers.
`--days-of-week <days>`	Days of the week, comma-separated, for time triggers.
`--event <event>`	The event type, for webhook triggers.
`--frequency <freq>`	`HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`, or `CRON`, for time triggers.
`--input <json>`	Agent input as a JSON object. For webhook triggers, embed `{webhook_event}`, `{webhook_action}`, and `{webhook_payload}` placeholders in any string value. They’re replaced with the incoming webhook’s values when the trigger fires.
`--minutes-of-hour <minutes>`	Minutes of the hour, comma-separated (`0`-`59`), for `HOURLY` triggers.
`--name <name>`	Rename the trigger. Works for any trigger type.
`--service-config <json>`	Service-specific config as JSON, for webhook triggers.
`--time <time>`	Time of day in `HH:MM` format, for time triggers.

​activate

​create

​Webhook trigger options

​Time trigger options

​API trigger options

​deactivate

​get

​list

​sessions

​update