Building Automations

Building Automations

Treat every automation as a route with one trigger → action. Event triggers select catalog events; scheduled triggers own their cadence. The action starts or signals a saved workflow or forwards the event.

Required process

1. Read the live declarations before editing:

   • "/static/codemode/providers/events.d.ts" for the event catalog;
   • "/static/codemode/providers/router.d.ts" for route schemas and actions;
   • "/static/codemode/workflow-authoring.d.ts" when saving a workflow;
   • "/static/codemode/providers/store.d.ts" only when durable key/value coordination is needed.

   Then inspect the event descriptor and existing artifacts:

   jsCopy code
   async () => {
     const catalog = await events.catalogList({});
     const eventDescriptor = await events.catalogGet({
       source: "telegram",
       eventType: "message.received",
     });
     const routes = await router.list({});
     const workflowFiles = await state.glob({
       pattern: "/workspace/automations/**/*.workflow.js",
     });
     return { catalog, eventDescriptor, routes, workflowFiles };
   };
   

   Complete when the exact catalog source and eventType, relevant existing routes and workflow files are known.

2. Choose the smallest topology that satisfies the request:

   • External or product event: route with an event trigger.
   • Time-based trigger: route with a schedule trigger.
   • New work: start_workflow.
   • Resume waiting work: send_workflow_event.
   • Cross-scope delivery: forward_event.

   Use stable, namespaced ids. For start_workflow, make workflowScriptPath point to a saved file containing exactly one statically named defineWorkflow(...). Backoffice validates the authored name from the file and keeps workflow-host routing internal. Complete when every trigger, action, file path, and instance-id template has one unambiguous value.

3. Check prerequisites. When an external capability is involved, inspect it with connections.get({ id }). If configuration is incomplete, use the Configuring Connections skill and collect the missing values from the user. Complete when every provider the automation will call is configured or the user has been told exactly what remains missing.

4. Create the required artifacts in dependency order: saved workflow, then route.

   Save workflow implementations in /workspace/automations/ with a .workflow.js suffix:

   jsCopy code
   async () => {
     const path = "/workspace/automations/telegram-hello.workflow.js";
     await state.writeFile({
       path,
       content: `defineWorkflow(
   { name: "telegram-hello" },
   async (event, step) => {
    return await step.do("capture-event", async () => {
      return { receivedEventId: event.id };
    });
   },
   );
   `,
     });
     return { path };
   };
   

   Grants

   Choose authority from the workflow's user source:

   • delegated-user: the triggering event already carries an internal user principal.
   • linked-user: resolve the external initiator's active user binding.

   For either user-backed mode, use grants: "inherit" when the workflow should retain the user's current permissions. The route remains a delegate, while role changes, bans, membership removal, and route disablement still apply. Use an explicit canonical grant array only when the route must narrow the user's authority.

   organization-automation has no user principal to inherit from. Give it the explicit canonical permissions used by its runtime tools. Creating or updating an explicit grant array requires the configuring execution to hold every requested grant. Complete when the authority mode names the intended principal and its grant policy is either inherited user authority or the smallest explicit automation grant set.

   Signal an existing durable workflow on a schedule, with an explicit IANA time zone:

   jsCopy code
   async () =>
     await router.create({
       id: "daily-digest",
       name: "Daily digest",
       trigger: {
         kind: "schedule",
         cadence: {
           kind: "cron",
           expression: "0 9 * * 1-5",
           timeZone: "America/New_York",
         },
       },
       action: {
         kind: "send_workflow_event",
         target: { kind: "instance_id", template: "daily-digest" },
         eventType: "scheduled",
       },
     });
   

   Create event-triggered routes with the router provider:

   jsCopy code
   async () => {
     return await router.create({
       id: "telegram-hello",
       name: "Telegram hello",
       trigger: {
         kind: "event",
         source: "telegram",
         eventType: "message.received",
         matcher: { path: "$.payload.text", op: "startsWith", value: "/hello" },
       },
       priority: 1000,
       action: {
         kind: "start_workflow",
         authority: { kind: "linked-user", grants: "inherit" },
         workflowScriptPath: "/workspace/automations/telegram-hello.workflow.js",
         instanceIdTemplate: "telegram-hello-${event.id}",
       },
     });
   };
   

   For send_workflow_event, identify the durable run only by its instance ID. Use { kind: "instance_id", template } when the event can render the workflow instance id directly. Use { kind: "stored_instance_id", keyTemplate } when a prior run stored the instance id under a rendered store key. Complete when every required artifact has been created or updated successfully.

5. Use the automation store only for small durable coordination values. Values are strings, structured values use JSON.stringify, and keys are stable and namespaced. Store inputs contain domain data only; trusted execution provenance is recorded by the kernel. Categories are ordinary labels. Use verification for JSON text that must satisfy a schema.

6. Re-read the completed route with router.get({ id }) and state.readFile({ path: workflowScriptPath }) when saved. Run connections.verify({ id }) for external providers. Complete only when the route trigger, action, workflow name, file path, and connection status all line up end to end.

Legacy router.cm.js files are outside this topology. Database-backed router rules are the routing source of truth; saved workflow files contain the behavior.