Automations

Automations let you run code in response to things that happen on the platform — a deploy completing, a comment being posted, or an external webhook firing. They're a flexible way to wire the platform into the rest of your toolchain.

Triggers

Automations start in response to a trigger. The platform supports the following:

Each automation has exactly one trigger and one or more actions.

Writing your first automation

Create a new file under .platform/automations/ in your project:

export default {
  trigger: 'deploy.succeeded',
  async run(event, ctx) {
    await ctx.notify('slack', {
      channel: '#deploys',
      message: `${event.project} is live at ${event.url}`
    });
  }
};

The file is detected on your next deploy and registered automatically.

A more useful example

Here's an automation that posts a summary to a chat channel whenever a pull request preview is ready:

export default {
  trigger: 'deploy.succeeded',
  filter: (event) => event.environment === 'preview',
  async run(event, ctx) {
    const summary = await ctx.ai.summarise({
      diff: event.diff,
      maxLength: 200
    });
 
    await ctx.notify('slack', {
      channel: '#previews',
      message: `Preview ready: ${event.url}\n\n${summary}`
    });
  }
};

This shows three patterns worth knowing:

• filter — narrow the events your automation responds to
• ctx.ai — a built-in helper for AI summarisation
• ctx.notify — send to any configured notification channel

Local testing

Test your automations locally before deploying:

platform automations test deploy.succeeded \
  --fixture fixtures/deploy.json

Scheduling

Use the schedule trigger with a cron expression for time-based automations:

export default {
  trigger: 'schedule',
  schedule: '0 9 * * 1', // every Monday at 09:00 UTC
  async run(event, ctx) {
    const stats = await ctx.api.deploys.weekly();
    await ctx.notify('email', {
      to: 'team@example.com',
      subject: 'Weekly deploy report',
      body: stats.summary
    });
  }
};

What's next?