Skip to Content
Skip to Content
Manage automations

Manage automations

View automation settings and execution history, create or update supported trigger types, and change their enabled state. Accessible automations and editing permissions depend on your account and organization policy.

Check settings and history

aipctl automation list aipctl automation list --name "Work summary" --json aipctl automation get AUTOMATION_ID aipctl automation get AUTOMATION_ID --json aipctl automation history AUTOMATION_ID aipctl automation history AUTOMATION_ID --page 2

Find an ID in the list, then review its settings and execution history. The list returns the first 50 automations and has no next-page option. Use the web interface to view more. Execution history supports subsequent pages through --page.

Retrieve trigger setup information

automation triggers retrieves service-specific information needed to configure a trigger, rather than a list of automations. Webhooks require a service type.

aipctl automation triggers webhook --service-type GITHUB

Supported --service-type values are GITHUB, JIRA, SALESFORCE, and CUSTOM. Review the returned information and use it in your webhook settings. This command does not create an automation or invoke a webhook.

Help also lists --account-id and --folder-id for external services, but retrieving trigger setup information for Gmail, Outlook, Google Drive, and Box is currently restricted in the CLI. Configure those connections through the web interface. Passing schedule or my-drive to this command to query those trigger settings is not supported.

Create a scheduled automation

First, check the agent you will use.

aipctl agent list

Save the following as automation.json and replace AGENT_ID with the actual ID. This example runs daily at 9:00 a.m. in the Asia/Seoul time zone.

{ "name": "Daily work summary", "triggerType": "SCHEDULE", "agentId": "AGENT_ID", "prompt": "Summarize the tasks to review today.", "triggerProviderType": "SCHEDULE", "trigger": { "schedule": { "timeZone": "Asia/Seoul", "recurrenceType": "DAILY", "recurrence": { "daily": { "frequency": 1, "timeOfDay": "09:00" } } } } }
aipctl automation create ./automation.json aipctl automation get NEW_AUTOMATION_ID

Use the returned ID to check the time zone, recurrence, agent, and enabled state. Enabling the automation runs the agent according to its schedule, so review the prompt and required resources first.

aipctl automation enable NEW_AUTOMATION_ID

After execution, check automation history. Successful creation or activation does not guarantee each execution succeeds.

Change settings

Save the following as automation-update.json and replace AGENT_ID with the actual ID. This example changes the daily execution time to 10:00 a.m. Do not include the creation field triggerType in an update request.

{ "name": "Daily work summary", "agentId": "AGENT_ID", "prompt": "Summarize today's tasks and their priorities.", "triggerProviderType": "SCHEDULE", "trigger": { "schedule": { "timeZone": "Asia/Seoul", "recurrenceType": "DAILY", "recurrence": { "daily": { "frequency": 1, "timeOfDay": "10:00" } } } } }
aipctl automation disable AUTOMATION_ID aipctl automation update AUTOMATION_ID ./automation-update.json aipctl automation get AUTOMATION_ID aipctl automation enable AUTOMATION_ID

An update file must include settings you want to retain, not just a single changed field. Check the details after applying it. Do not use the entire query result as the input file.

Inputs for webhook and My Drive automations

Creation and update commands both accept JSON files, but the fields depend on the trigger.

TypetriggerType on creationtriggerProviderTypeField inside trigger
ScheduleSCHEDULESCHEDULEschedule
WebhookWEBHOOKWEBHOOKwebhook
My Drive folder watchFOLDER_WATCHMY_DRIVEmyDrive

For example, to process PDFs added to a My Drive folder, prepare this creation file. Replace AGENT_ID and FOLDER_ID with actual values. Find the folder ID with aipctl drive list.

{ "name": "Organize PDF documents", "triggerType": "FOLDER_WATCH", "agentId": "AGENT_ID", "prompt": "Summarize the uploaded PDF documents.", "triggerProviderType": "MY_DRIVE", "trigger": { "myDrive": { "folderId": "FOLDER_ID", "watchSubfolders": false, "fileNamePatterns": ["*.pdf"] } } }

watchSubfolders controls whether subfolders are watched; fileNamePatterns selects matching filenames. Check that the agent has the settings and permissions needed to read and process the files.

For a webhook, include serviceType and the required config inside webhook. Build config using the output of automation triggers webhook --service-type ... above. Webhook URLs and secrets may be masked in detail queries, so also follow the web interface’s connection instructions.

Disable or delete an automation

aipctl automation disable AUTOMATION_ID aipctl automation get AUTOMATION_ID aipctl automation delete AUTOMATION_ID --force

disable changes the enabled state. It does not mean a running task has been canceled immediately. Check progress in the execution history.

Supported scope

TaskScope
Create, update, delete, enable, or disableSchedule (SCHEDULE), webhook (WEBHOOK), and My Drive (MY_DRIVE) triggers
Automations for other external servicesThe CLI may show saved details while restricting changes. Configure them through the web interface.
Run now, cancel a run, or regenerate a webhook URLAvailable where the operation is permitted.

Include only one trigger configuration matching its type. Do not reuse the schedule example’s schedule field for other trigger types. See the web automation guide for webhook and My Drive setup.

Run now and cancel a run

Run an automation immediately or request cancellation of a specific execution. Use the web interface if execution is restricted in your environment.

aipctl automation get AUTOMATION_ID aipctl automation run AUTOMATION_ID aipctl automation history AUTOMATION_ID

run requests immediate execution for supported automations, such as scheduled ones. Types that do not support manual execution, such as webhooks, may reject it. A successful request does not mean execution has finished; check the history. Running an agent may incur usage.

To cancel, specify the sequence number from the history.

aipctl automation cancel AUTOMATION_ID SEQ aipctl automation history AUTOMATION_ID

SEQ is the integer sequence number in the history, not the automation ID. Check whether the execution can be canceled. Completed runs may reject cancellation, and a successful request does not prove every external task has stopped. Check the final state.

Regenerate a webhook URL

Check that the automation uses a webhook before running:

aipctl automation webhook-regen AUTOMATION_ID

The URL is masked by default. If you need the full new URL, use this option in a private terminal.

aipctl automation webhook-regen AUTOMATION_ID --show-sensitive

Running the command again requests another regeneration. The option does not simply reveal the URL from your first request. Decide whether you need the full URL before running it. After regeneration, update the sending service’s destination URL and verify delivery. Check whether the old URL remains in use, and do not share terminals or logs containing the URL.

Last updated on