Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.poolside.ai/llms.txt

Use this file to discover all available pages before exploring further.

BETA This feature is in beta and may change before general availability.

Overview

Automation lets you trigger orchestration workflows without manually starting them from the Console. Use automation when you want work to happen on a recurring basis or in response to external events. Orchestration separates what to run from when to run it. You define the work as a task or a pipeline, then attach triggers to start it automatically. See Workflows and triggers for how these layers fit together.
ObjectWhat it does
https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/tasks-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=f6baa73cf61826fb0d727df8947aedd5 TaskDefines what to run: an agent session with a specific agent, sandbox, and prompt. A task is independent of its trigger.
https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/schedules-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=fd9b08f9d650dc98650403fceb182047 ScheduleDefines when to run it: a cron-based trigger that starts one or more tasks at defined intervals.
https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/webhooks-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=92f6b174bd11b2f3a56dcd7168a434c0 Webhook endpointDefines when to run it: an HTTPS endpoint that receives external events and routes matching requests to pipeline builds through webhook actions.

Create a task

A task defines what to run. The current task type is agent_session, which starts an agent session with a prompt you provide. Prerequisites
  • You can access Orchestration > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/tasks-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=f6baa73cf61826fb0d727df8947aedd5 Tasks in the Poolside Console.
  • A managed agent exists for the task.
  • A sandbox definition exists for the task. The sandbox controls the execution environment for the agent session.
Steps
  1. In the Poolside Console, navigate to Orchestration > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/tasks-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=f6baa73cf61826fb0d727df8947aedd5 Tasks.
  2. Click New Task.
  3. Enter a Name.
  4. Optional: Enter a Description.
  5. For Type, select Agent Session.
  6. Select an Agent. This is the managed agent that runs when the task executes.
  7. Select a Sandbox Definition. This controls the compute environment for the agent session.
  8. Enter the Prompt to send to the agent when the task runs.
  9. Click Save.

Create a schedule

A schedule triggers one or more tasks on a recurring cron interval. Prerequisites
  • You can access Orchestration > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/schedules-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=fd9b08f9d650dc98650403fceb182047 Schedules in the Poolside Console.
  • At least one task exists.
Steps
  1. In the Poolside Console, navigate to Orchestration > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/schedules-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=fd9b08f9d650dc98650403fceb182047 Schedules.
  2. Click New Schedule.
  3. Enter a Name.
  4. Enter a Cron Expression using standard cron syntax. For example, 0 9 * * 1-5 runs at 9:00 AM every weekday.
  5. Optional: Enter a Description.
  6. Click Create Schedule.
  7. Open the schedule.
  8. In Tasks, click Add Task and select the task you want to run on this schedule.
Review past and upcoming runs in the Task Invocations section on the schedule or task detail page.

Set up a webhook endpoint

Use webhooks when you want an external provider to trigger orchestration from an incoming event, such as a new issue in Linear, a push to GitHub, or a custom event from your own systems. Webhook setup has two parts: create the endpoint in the Console, then configure your external provider to send events to it. Prerequisites
  • You can access Orchestration > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/webhooks-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=92f6b174bd11b2f3a56dcd7168a434c0 Webhooks in the Poolside Console.
  • You know the external provider’s webhook signing format, including the hash algorithm and how it encodes the signature.
Steps
  1. In the Poolside Console, navigate to Orchestration > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/webhooks-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=92f6b174bd11b2f3a56dcd7168a434c0 Webhooks.
  2. Click New Webhook Endpoint.
  3. Enter a Name.
  4. In Signing secret, copy the generated Secret value and store it securely. You need this value to configure the external provider.
    Copy the signing secret now. Poolside stores it as a credential and does not show the value again after you leave this page.
  5. Select the Hash Algorithm and Encoding that match the external provider’s signing format.
  6. Enter a Signature Value Expression that extracts the signature from the incoming request. For example, for a provider that sends the signature in an X-Signature header: headers["X-Signature"].
  7. If Encoding is not Plain Text, enter a Signature Data Expression that specifies what data the provider signs.
  8. Enter a Delivery ID Expression that extracts a unique identifier from the request. Orchestration uses this to prevent duplicate processing. For example: headers["X-Request-Id"].
  9. Optional: Add Custom handlers for provider-specific handshakes. Some providers, such as Slack, send a URL verification challenge that must return a specific response before the endpoint is active.
  10. Click Save.
  11. Open the endpoint and copy the generated webhook URL. It follows the pattern: POST /v0/bridge/webhook-endpoints/<webhook-endpoint-id>.
  12. In the external provider’s settings, add the webhook URL and signing secret.

Configure webhook actions

Webhook actions determine which pipeline steps run when an event arrives. Actions are defined in code using WebhookPipelineAction in the Bridge SDK and appear on the webhook endpoint page after the repository is indexed. From the endpoint page, you can turn individual actions on or off. When an event arrives, orchestration evaluates the on expression for each active action. If the expression returns true, orchestration applies the transform expression to map the payload to step inputs and starts a build.