search
Book a Demo

Automations

Create and configure automations, revisions, schedules, triggers, and connections.

hashtag
Get Automation

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Responses
chevron-right
200

A successful response.

application/json

Automation represents a unit of executable code with associated metadata and dependencies. Automations can be in DRAFT or PUBLISHED state, where drafts can be modified and published automations are immutable and executable. Automation IDs are unique nano ID strings (21 characters, URL-safe: A-Za-z0-9_-).

namestringOptional
display_namestringRequired

Human-readable name of the automation for identification and display. Must be unique within the user's namespace.

english_codestringOptional

User-facing English description code that explains what the automation does. This is a human-readable representation of the automation's purpose and logic.

codestringOptional

SPy (Subset-of Python) executable code that defines the automation logic. This code is executed when the automation is invoked with inputs.

create_timestring · date-timeRead-onlyOptional

Timestamp when the automation was originally created. This value never changes after creation.

versionstringRead-onlyOptional
update_timestring · date-timeRead-onlyOptional

Timestamp when the automation was last updated. Updated whenever the automation metadata, code, or dependencies change.

update_user_idstringRead-onlyOptional

The ID of the user who last updated this automation.

delete_timestring · date-timeRead-onlyOptional

Timestamp when the automation was deleted.

purge_timestring · date-timeRead-onlyOptional

Timestamp when the automation will be purged.

descriptionstringOptional

Provides additional context and documentation about the automation's purpose and behavior.

latest_published_versionstringRead-onlyOptional
author_idstringRead-onlyOptional

The ID of the user who created this automation.

restore_timestring · date-timeRead-onlyOptional

Timestamp when the automation was restored from a previous version. Only populated if the automation has been restored.

restore_versionstringRead-onlyOptional

The version string this automation was restored from (e.g., "1.0", "2.1"). Only populated if the automation has been restored.

restore_user_idstringRead-onlyOptional

The ID of the user who restored this automation. Only populated if the automation has been restored.

publish_timestring · date-timeRead-onlyOptional

Timestamp when the automation was last published. Only populated if the automation has been published.

publish_user_idstringRead-onlyOptional

The ID of the user who last published this automation. Only populated if the automation has been published.

activation_statestring · enumOptional

Activation state of a published automation. Controls whether the automation can execute published runs.

  • AUTOMATION_ACTIVATION_STATE_UNSPECIFIED: Unspecified state. Used when automation has no published version. Activation state is only meaningful after publishing.
  • AUTOMATION_ACTIVATION_STATE_ACTIVE: Automation is active and can execute published runs.
  • AUTOMATION_ACTIVATION_STATE_DEACTIVATED: Automation is deactivated and cannot execute published runs. Events will be logged but not executed.
Default: AUTOMATION_ACTIVATION_STATE_UNSPECIFIEDPossible values:
marked_outputsstring[]Optional

List of output keys that have been marked by the user. These keys identify specific outputs from the automation execution.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}

hashtag
Query Automation

get

This custom method allows explicit selection of which version stage to retrieve:

  • AUTOMATION_STAGE_DRAFT: Returns the latest draft version

  • AUTOMATION_STAGE_PUBLISHED: Returns the latest published version

Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Query parameters
stagestring · enumRequired

The publication stage of the automation to retrieve. Determines which version of the automation to return:

  • AUTOMATION_STAGE_DRAFT: Returns the latest draft version

  • AUTOMATION_STAGE_PUBLISHED: Returns the latest published version

  • AUTOMATION_STAGE_UNSPECIFIED: Automation stage is not specified.

  • AUTOMATION_STAGE_DRAFT: Automation is in draft stage and can be modified.

  • AUTOMATION_STAGE_PUBLISHED: Automation is published and immutable, ready for execution.

Default: AUTOMATION_STAGE_UNSPECIFIEDPossible values:
Responses
chevron-right
200

A successful response.

application/json

Automation represents a unit of executable code with associated metadata and dependencies. Automations can be in DRAFT or PUBLISHED state, where drafts can be modified and published automations are immutable and executable. Automation IDs are unique nano ID strings (21 characters, URL-safe: A-Za-z0-9_-).

namestringOptional
display_namestringRequired

Human-readable name of the automation for identification and display. Must be unique within the user's namespace.

english_codestringOptional

User-facing English description code that explains what the automation does. This is a human-readable representation of the automation's purpose and logic.

codestringOptional

SPy (Subset-of Python) executable code that defines the automation logic. This code is executed when the automation is invoked with inputs.

create_timestring · date-timeRead-onlyOptional

Timestamp when the automation was originally created. This value never changes after creation.

versionstringRead-onlyOptional
update_timestring · date-timeRead-onlyOptional

Timestamp when the automation was last updated. Updated whenever the automation metadata, code, or dependencies change.

update_user_idstringRead-onlyOptional

The ID of the user who last updated this automation.

delete_timestring · date-timeRead-onlyOptional

Timestamp when the automation was deleted.

purge_timestring · date-timeRead-onlyOptional

Timestamp when the automation will be purged.

descriptionstringOptional

Provides additional context and documentation about the automation's purpose and behavior.

latest_published_versionstringRead-onlyOptional
author_idstringRead-onlyOptional

The ID of the user who created this automation.

restore_timestring · date-timeRead-onlyOptional

Timestamp when the automation was restored from a previous version. Only populated if the automation has been restored.

restore_versionstringRead-onlyOptional

The version string this automation was restored from (e.g., "1.0", "2.1"). Only populated if the automation has been restored.

restore_user_idstringRead-onlyOptional

The ID of the user who restored this automation. Only populated if the automation has been restored.

publish_timestring · date-timeRead-onlyOptional

Timestamp when the automation was last published. Only populated if the automation has been published.

publish_user_idstringRead-onlyOptional

The ID of the user who last published this automation. Only populated if the automation has been published.

activation_statestring · enumOptional

Activation state of a published automation. Controls whether the automation can execute published runs.

  • AUTOMATION_ACTIVATION_STATE_UNSPECIFIED: Unspecified state. Used when automation has no published version. Activation state is only meaningful after publishing.
  • AUTOMATION_ACTIVATION_STATE_ACTIVE: Automation is active and can execute published runs.
  • AUTOMATION_ACTIVATION_STATE_DEACTIVATED: Automation is deactivated and cannot execute published runs. Events will be logged but not executed.
Default: AUTOMATION_ACTIVATION_STATE_UNSPECIFIEDPossible values:
marked_outputsstring[]Optional

List of output keys that have been marked by the user. These keys identify specific outputs from the automation execution.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:query

hashtag
Get Automation Revision

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
revision_idstringRequired
Responses
chevron-right
200

A successful response.

application/json

AutomationRevision represents a historical revision (version) of an automation. Revisions are immutable snapshots created each time an automation is updated. Per AIP-162, this resource contains the complete state via a snapshot field.

namestringOptional

The name of the automation revision. Format: organizations/{organization}/workspaces/{workspace}/automations/{automation}/revisions/{revision} The revision ID is the semantic version string (e.g., "0.1", "1.0", "2.0").

create_timestring · date-timeRead-onlyOptional

Timestamp when this revision was created.

alternate_idsstring[]Read-onlyOptional

Other revision IDs that reference the same snapshot (e.g., "latest"). Per AIP-162, this allows aliases for revisions.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/revisions/{revision_id}

hashtag
List Automation Revisions

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Query parameters
page_sizeinteger · int32Optional

The maximum number of revisions to return in a single response. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token received from a previous ListAutomationRevisions call. Provide this to retrieve the subsequent page of results.

filterstringOptional

Filter expression to restrict results. Per AIP-160, this should be a filtering expression following the Common Expression Language (CEL) syntax.

Supported fields for filtering:

  • stage: The automation revision stage (e.g., DRAFT, PUBLISHED)

Example filters:

  • stage = "DRAFT" - Returns only draft revisions
  • stage = "PUBLISHED" - Returns only published revisions

If not specified or passed null, all revisions will be returned for that automation.

Responses
chevron-right
200

A successful response.

application/json

ListAutomationRevisionsResponse returns a page of automation revisions and pagination information.

next_page_tokenstringOptional

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/revisions

hashtag
List Automations

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
Query parameters
page_sizeinteger · int32Optional

The maximum number of automations to return in a single response. The service may return fewer than this value. If unspecified, at most 10 automations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If negative, an INVALID_ARGUMENT error will be returned.

page_tokenstringOptional

A page token received from a previous ListAutomations call. Provide this to retrieve the subsequent page of results. When paginating, all other parameters provided to ListAutomations must match the call that provided the page token.

show_deletedbooleanOptional

Filter to show/hide deleted automations. Deleted automations will be hidden by default.

filterstringOptional

Filter expression to restrict results. Per AIP-160, this should be a filtering expression following the Common Expression Language (CEL) syntax.

Supported fields for filtering:

  • state: The automation state (e.g., DRAFT, PUBLISHED)

Example filters:

  • state = "PUBLISHED"
order_bystringOptional

Reserved for future use. Comma-separated list of fields to order results by. Per AIP-132, this should be a string containing one or more field names, each optionally followed by "asc" or "desc" to specify sort direction.

Currently not implemented. Results are always ordered by update_time desc (most recently updated first).

Responses
chevron-right
200

A successful response.

application/json

ListAutomationsResponse returns a page of automations and pagination information.

next_page_tokenstringOptional

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations

hashtag
Invoke Automation

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body

InvokeAutomationRequest contains the automation ID and inputs needed to execute an automation.

stagestring · enumRequired

AutomationStage represents the publication stage of an automation. This enum is shared across services that manage or execute automations.

  • AUTOMATION_STAGE_UNSPECIFIED: Automation stage is not specified.
  • AUTOMATION_STAGE_DRAFT: Automation is in draft stage and can be modified.
  • AUTOMATION_STAGE_PUBLISHED: Automation is published and immutable, ready for execution.
Default: AUTOMATION_STAGE_UNSPECIFIEDPossible values:
Responses
chevron-right
200

A successful response.

application/json

InvokeAutomationResponse returns the run ID for tracking the automation execution.

run_idstringOptional

Unique identifier of the run created to execute the automation. Use this ID to track execution status and retrieve results.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:invoke

hashtag
List Default Inputs History

get

Results are returned in reverse chronological order (newest first). Optionally filter by stage (DRAFT or PUBLISHED).

Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Query parameters
page_sizeinteger · int32Optional

Maximum number of entries to return. Defaults to 50 if not specified.

page_tokenstringOptional

Page token for pagination, from a previous ListDefaultInputsHistoryResponse.

Responses
chevron-right
200

A successful response.

application/json

ListDefaultInputsHistoryResponse contains a paginated list of default input history entries.

next_page_tokenstringOptional

Token for retrieving the next page. Empty if no more results.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:listDefaultInputsHistory

hashtag
Count Connection Usage

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
Body

CountConnectionUsageRequest specifies connection IDs to count automation usage for.

connection_idsstring[]Required

List of connection IDs to count automation usage for. Each connection ID will have a corresponding entry in the response.

Responses
chevron-right
200

A successful response.

application/json

CountConnectionUsageResponse returns automation counts for each requested connection ID.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations:countConnectionUsage

hashtag
Trace Connection Usage

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
Body

TraceConnectionUsageRequest specifies which connection to trace usage for.

connection_idstringRequired

The connection ID to trace usage for. Returns all automations that use this connection.

Responses
chevron-right
200

A successful response.

application/json

TraceConnectionUsageResponse returns automations that use the specified connection.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations:traceConnectionUsage

hashtag
Extract Automation Code Connections

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Query parameters
filterstringRequired

Filter expression to restrict results. Per AIP-160, this should be a filtering expression following the Common Expression Language (CEL) syntax.

Supported fields for filtering:

  • stage: The automation stage to extract connections from (e.g., DRAFT, PUBLISHED)

Example filters:

  • stage = "DRAFT"
  • stage = "PUBLISHED"
Responses
chevron-right
200

A successful response.

application/json

ExtractAutomationCodeConnectionsResponse returns connection information from the automation's SPy code.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:extractCodeConnections

hashtag
Upgrade Automation Connections

post

Multiple connections can be upgraded in a single atomic operation. All upgrades succeed together or all fail together. The automation version is incremented once for all upgrades.

This operation only works on draft automations. To upgrade connections in a published automation, first use ForkPublishedAutomation to create a draft, then call this method.

Per AIP-136, this is a custom method using the :upgradeConnections suffix.

Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body

UpgradeAutomationConnectionsRequest specifies which connections to upgrade in a draft automation.

Responses
chevron-right
200

A successful response.

application/json

UpgradeAutomationConnectionsResponse returns the updated automation.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:upgradeConnections

hashtag
Switch Automation Connections

post

Multiple connections can be switched in a single atomic operation. All switches succeed together or all fail together. The automation version is incremented once for all switches.

This operation only works on draft automations. To switch connections in a published automation, first use ForkPublishedAutomation to create a draft, then call this method.

Per AIP-136, this is a custom method using the :switchConnections suffix.

Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body

SwitchAutomationConnectionsRequest specifies which connections to switch in a draft automation.

Responses
chevron-right
200

A successful response.

application/json

SwitchAutomationConnectionsResponse returns the updated automation.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:switchConnections

hashtag
Remove Automation Connections

post

Multiple connections can be removed in a single atomic operation. All removals succeed together or all fail together. The automation version is incremented once for all removals.

This operation only works on draft automations. To remove connections in a published automation, first use ForkPublishedAutomation to create a draft, then call this method.

Per AIP-136, this is a custom method using the :removeConnections suffix.

Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body

RemoveAutomationConnectionsRequest specifies which connections to remove from a draft automation.

Responses
chevron-right
200

A successful response.

application/json

RemoveAutomationConnectionsResponse returns the updated automation.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:removeConnections

hashtag
Add Automation Connections

post

Multiple connections can be added in a single atomic operation. All additions succeed together or all fail together. The automation version is incremented once for all additions.

This operation only works on draft automations. To add connections to a published automation, first use ForkPublishedAutomation to create a draft, then call this method.

Per AIP-136, this is a custom method using the :addConnections suffix.

Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body

AddAutomationConnectionsRequest specifies which connections to add to a draft automation.

Responses
chevron-right
200

A successful response.

application/json

AddAutomationConnectionsResponse returns the updated automation.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:addConnections

hashtag
Get Automation Visualization

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Responses
chevron-right
200

A successful response.

application/json

AutomationVisualization represents a visual representation of an automation's execution flow. Visualizations are generated for published automation versions and stored as configurations for rendering in the UI. This is a singleton resource - each automation has exactly one visualization representing its latest published version.

namestringOptional
automation_versionstringRead-onlyOptional

The semantic version of the automation this visualization represents. Format: "major.0" (e.g., "1.0", "2.0", "3.0") - always a published version. This corresponds to the automation's published version at the time of generation.

statestring · enumOptional

VisualizationState indicates the current state of visualization generation.

  • VISUALIZATION_STATE_UNSPECIFIED: Unspecified state.
  • VISUALIZATION_STATE_PENDING: Visualization generation is in progress.
  • VISUALIZATION_STATE_COMPLETED: Visualization generation completed successfully.
  • VISUALIZATION_STATE_FAILED: Visualization generation failed.
Default: VISUALIZATION_STATE_UNSPECIFIEDPossible values:
error_messagestringRead-onlyOptional

Error message describing why generation failed. Only populated when state is VISUALIZATION_STATE_FAILED.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/visualization

hashtag
Get Automation Schedule

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Responses
chevron-right
200

A successful response.

application/json

AutomationSchedule represents a schedule for invoking an automation. Each automation can have at most one schedule. Kestra is the source of truth.

namestringOptional
enabledbooleanRead-onlyOptional

Whether the schedule is currently enabled. Disabled schedules do not trigger automation invocations.

summarystringRead-onlyOptional
next_run_timesstring · date-time[]Read-onlyOptional

List of the next scheduled execution times. Useful for preview and verification. Backend generates these.

remaining_occurrencesinteger · int32Read-onlyOptional

Number of remaining occurrences if the schedule has an end condition. Only populated when config.end.end_type is SCHEDULE_END_TYPE_AFTER_OCCURRENCES.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/schedule

hashtag
Create Automation Schedule

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body

AutomationSchedule represents a schedule for invoking an automation. Each automation can have at most one schedule. Kestra is the source of truth.

namestringOptional
enabledbooleanRead-onlyOptional

Whether the schedule is currently enabled. Disabled schedules do not trigger automation invocations.

summarystringRead-onlyOptional
next_run_timesstring · date-time[]Read-onlyOptional

List of the next scheduled execution times. Useful for preview and verification. Backend generates these.

remaining_occurrencesinteger · int32Read-onlyOptional

Number of remaining occurrences if the schedule has an end condition. Only populated when config.end.end_type is SCHEDULE_END_TYPE_AFTER_OCCURRENCES.

Responses
chevron-right
200

A successful response.

application/json

AutomationSchedule represents a schedule for invoking an automation. Each automation can have at most one schedule. Kestra is the source of truth.

namestringOptional
enabledbooleanRead-onlyOptional

Whether the schedule is currently enabled. Disabled schedules do not trigger automation invocations.

summarystringRead-onlyOptional
next_run_timesstring · date-time[]Read-onlyOptional

List of the next scheduled execution times. Useful for preview and verification. Backend generates these.

remaining_occurrencesinteger · int32Read-onlyOptional

Number of remaining occurrences if the schedule has an end condition. Only populated when config.end.end_type is SCHEDULE_END_TYPE_AFTER_OCCURRENCES.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/schedule

hashtag
Delete Automation Schedule

delete
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Responses
chevron-right
200

A successful response.

application/json
objectOptional
delete
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/schedule

hashtag
Update Automation Schedule

patch
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body
enabledbooleanRead-onlyOptional

Whether the schedule is currently enabled. Disabled schedules do not trigger automation invocations.

summarystringRead-onlyOptional
next_run_timesstring · date-time[]Read-onlyOptional

List of the next scheduled execution times. Useful for preview and verification. Backend generates these.

remaining_occurrencesinteger · int32Read-onlyOptional

Number of remaining occurrences if the schedule has an end condition. Only populated when config.end.end_type is SCHEDULE_END_TYPE_AFTER_OCCURRENCES.

Responses
chevron-right
200

A successful response.

application/json

AutomationSchedule represents a schedule for invoking an automation. Each automation can have at most one schedule. Kestra is the source of truth.

namestringOptional
enabledbooleanRead-onlyOptional

Whether the schedule is currently enabled. Disabled schedules do not trigger automation invocations.

summarystringRead-onlyOptional
next_run_timesstring · date-time[]Read-onlyOptional

List of the next scheduled execution times. Useful for preview and verification. Backend generates these.

remaining_occurrencesinteger · int32Read-onlyOptional

Number of remaining occurrences if the schedule has an end condition. Only populated when config.end.end_type is SCHEDULE_END_TYPE_AFTER_OCCURRENCES.

patch
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/schedule

hashtag
Disable Automation Schedule

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body
objectOptional

DisableAutomationScheduleRequest is the request to disable a schedule (pause without deleting).

Responses
chevron-right
200

A successful response.

application/json

DisableAutomationScheduleResponse contains the disabled schedule.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:disableAutomationSchedule

hashtag
Enable Automation Schedule

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body
objectOptional

EnableAutomationScheduleRequest is the request to enable a previously disabled schedule.

Responses
chevron-right
200

A successful response.

application/json

EnableAutomationScheduleResponse contains the enabled schedule.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}:enableAutomationSchedule

hashtag
Delete Workspace Connection

delete

This API validates that the connection is not in use by any published automations before deletion. If only draft automations use the connection, deletion proceeds and returns the list of affected automations.

The affected draft automations will have unresolved connection references after deletion. They can still be edited but cannot be published until new connections are configured.

Errors:

  • FAILED_PRECONDITION: Connection is in use by one or more published automations. The error details include DeleteConnectionBlockedError with blocking automations.

  • NOT_FOUND: Connection not found in the workspace.

  • INTERNAL: Failed to communicate with the connection storage service.

Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
Query parameters
connection_idstringRequired

The connection ID to delete.

Responses
chevron-right
200

A successful response.

application/json

DeleteWorkspaceConnectionResponse returns information about affected automations.

delete
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations:deleteConnection

hashtag
List Automation Triggers

get
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Query parameters
page_sizeinteger · int32Optional

The maximum number of triggers to return in a single response. The service may return fewer than this value. If unspecified, a default page size will be used.

page_tokenstringOptional

A page token received from a previous ListAutomationTriggers call. Provide this to retrieve the subsequent page of results.

filterstringOptional

A filter expression to apply to the list of triggers.

Responses
chevron-right
200

A successful response.

application/json

Response containing the list of active triggers for an automation.

next_page_tokenstringOptional

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

get
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/triggers

hashtag
Create Automation Trigger

post
Authorizations
AuthorizationstringRequired

Personal Access Token.

Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
Body

AutomationTrigger represents phase configuration metadata for an external trigger. The trigger itself is created and managed by another service; this message stores additional metadata about how the trigger relates to automation phases.

trigger_idstringRequired

The external trigger ID created by another service. This ID uniquely identifies the trigger in the external system.

automationstringRead-onlyOptional
phase_typestring · enumRequired

PhaseType defines the type of phase for an automation trigger.

  • PHASE_TYPE_UNSPECIFIED: Unspecified phase type.
  • PHASE_TYPE_PRE: Pre-processing phase.
  • PHASE_TYPE_MAIN: Main processing phase.
  • PHASE_TYPE_POST: Post-processing phase.
Default: PHASE_TYPE_UNSPECIFIEDPossible values:
phase_sub_typestring · enumOptional

PhaseSubType defines the sub-type within a phase for an automation trigger.

  • PHASE_SUB_TYPE_UNSPECIFIED: Unspecified phase sub-type.
  • PHASE_SUB_TYPE_EMAIL: Email trigger sub-type.
  • PHASE_SUB_TYPE_SCHEDULE: Schedule-based trigger sub-type.
  • PHASE_SUB_TYPE_WEBHOOK: Webhook trigger sub-type.
  • PHASE_SUB_TYPE_API: API trigger sub-type.
Default: PHASE_SUB_TYPE_UNSPECIFIEDPossible values:
is_activebooleanOptional

Whether this trigger is currently active.

Responses
chevron-right
200

A successful response.

application/json

AutomationTrigger represents phase configuration metadata for an external trigger. The trigger itself is created and managed by another service; this message stores additional metadata about how the trigger relates to automation phases.

trigger_idstringRequired

The external trigger ID created by another service. This ID uniquely identifies the trigger in the external system.

automationstringRead-onlyOptional
phase_typestring · enumRequired

PhaseType defines the type of phase for an automation trigger.

  • PHASE_TYPE_UNSPECIFIED: Unspecified phase type.
  • PHASE_TYPE_PRE: Pre-processing phase.
  • PHASE_TYPE_MAIN: Main processing phase.
  • PHASE_TYPE_POST: Post-processing phase.
Default: PHASE_TYPE_UNSPECIFIEDPossible values:
phase_sub_typestring · enumOptional

PhaseSubType defines the sub-type within a phase for an automation trigger.

  • PHASE_SUB_TYPE_UNSPECIFIED: Unspecified phase sub-type.
  • PHASE_SUB_TYPE_EMAIL: Email trigger sub-type.
  • PHASE_SUB_TYPE_SCHEDULE: Schedule-based trigger sub-type.
  • PHASE_SUB_TYPE_WEBHOOK: Webhook trigger sub-type.
  • PHASE_SUB_TYPE_API: API trigger sub-type.
Default: PHASE_SUB_TYPE_UNSPECIFIEDPossible values:
is_activebooleanOptional

Whether this trigger is currently active.

post
/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/automations/{automation_id}/triggers
PreviousWorkspacesNextRuns

Last updated

Was this helpful?