v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-224341,4072.0 MB

Automations

Create Automation

Create a new automation with the specified steps, triggers, and configuration.

post/api/v1/automations

Request body

annotationsobject

Bounded key/value metadata bag for IaC marking and customer tags. See .rfcs/object-annotations.md §2. Limits: ≤16 entries; keys 1–128 chars matching ^[A-Za-z][A-Za-z0-9._/-]{0,127}$; values 0–256 chars matching URL-safe ASCII; total serialized ≤4096 bytes. Keys starting with c1/ are reserved for server-managed use and rejected on write.

Well-known keys: managed_by, iac_workspace, iac_resource_address, iac_tool_version.

appIdstring

the app id this workflow_template belongs to

circuitBreakerMaxinteger

Circuit breaker rate cap. See Automation.circuit_breaker_max for semantics.

circuitBreakerPeriod'CIRCUIT_BREAKER_PERIOD_UNSPECIFIED' | 'CIRCUIT_BREAKER_PERIOD_HOUR' | 'CIRCUIT_BREAKER_PERIOD_DAY' | 'CIRCUIT_BREAKER_PERIOD_WEEK' | 'CIRCUIT_BREAKER_PERIOD_MONTH'

The circuitBreakerPeriod field.

descriptionstring

Optional description explaining the automation's purpose.

displayNamestring

Human-readable name for the automation.

enabledboolean

Whether the automation is active and eligible for execution.

isDraftboolean

Whether this automation is in draft mode. Draft automations are not eligible for trigger-based execution.

Response

Successful response

webhookCapabilityUrlstring

One-time absolute webhook URL for capability URL authentication, shown once at creation time. Contains the full URL including the embedded token (e.g. https://tenant.conductorone.com/api/v1/webhooks/incoming/{id}/t/{token}). Populated only when the webhook trigger uses capability URL authentication.

webhookHmacSecretstring

One-time HMAC shared secret, shown once at creation time. Populated only when the webhook trigger uses HMAC authentication.