Documentation

AutomationSummary

Schema

Fields

· 13
id string required

Automation ID.

projectId string required

Project ID that owns the automation.

name string required

Automation name.

enabled boolean required

Whether the automation is currently enabled.

triggerKind string · enum required

Configured automation trigger kind.

values

  • manual
  • live_deployed
  • branch_merged
  • branch_created
  • branch_removed
  • cron
triggerDescription string required

Human-readable trigger summary.

actionKinds array of string required

Action kinds configured on the automation, in order.

values

  • run_tests
  • deploy_agent
  • send_message
  • send_webhook
canRunManually boolean required

Whether this automation can be run through the Manual / API trigger.

createdByName string · nullable required

Display name of the user who created the automation.

createdAt number required

Creation time in unix milliseconds.

updatedAt number required

Last update time in unix milliseconds.

lastRunAt number · nullable required

Most recent execution time in unix milliseconds, if the automation has run.

lastRunError string · nullable required

Last recorded execution error, if any.