Represents an automated workflow configuration that defines custom deployment processes and CI/CD pipelines. Workflows allow for complex, multi-step automation beyond the default Cloud66 deployment process.
uidstringUnique identifier for the workflow (UUID format).
namestringHuman-readable name of the workflow.
defaultbooleanIndicates whether this is the default workflow for the associated formation or stack.
tagsarrayArray of tag strings associated with this workflow for organization and filtering.
bodystringWorkflow definition body containing the actual workflow YAML configuration (only included when full_content=true).
created_at_isostringISO 8601 formatted timestamp indicating when the workflow was created.
updated_at_isostringISO 8601 formatted timestamp indicating when the workflow was last updated.
Workflow Configuration
The body field contains YAML configuration that defines:
- Steps - Individual tasks and commands to execute
- Dependencies - Step execution order and prerequisites
- Conditions - When and how steps should execute
- Environment - Variables and settings for execution
- Notifications - Alert configurations for workflow events
Default Workflows
When default is true, this workflow serves as the primary automation process for deployments. Non-default workflows can be triggered manually or by specific conditions.
Workflow Execution
Workflows are executed as part of:
- Deployment Pipelines - Automated deployment processes
- Manual Triggers - On-demand workflow execution
- Event-Based Triggers - Triggered by specific stack or formation events
- Scheduled Runs - Time-based workflow execution
Use Cases
- Custom Deployment Steps - Beyond standard Cloud66 deployment process
- Integration Testing - Automated testing during deployments
- Database Migrations - Coordinated database updates
- External Service Integration - Calling external APIs or services
- Multi-Environment Promotion - Coordinating deployments across environments
Example
{
"uid": "workflow-550e8400-e29b-41d4-a716",
"name": "production-deployment",
"default": true,
"tags": [
"production",
"deployment",
"rails"
],
"body": "version: '1'\nsteps:\n - name: run-tests\n command: bundle exec rspec\n on_success: deploy\n - name: deploy\n command: cap production deploy\n notifications:\n - type: slack\n channel: '#deployments'",
"created_at_iso": "2024-01-15T10:30:00Z",
"updated_at_iso": "2024-02-10T16:45:00Z"
}