Create an action trigger – POST /v1/actions/{actionId}/triggers

Create an action trigger

Requires invocation permission on the published action and authority to delegate every capability it declares (SDK permissions, connectors, and sources). A schedule trigger invokes the action’s current published revision with its fixed input at each UTC slot, as the workspace system identity. Runs do not recheck access. They recheck input, and lasting failures (a deleted or unpublished action, or input which no longer matches the contract) disable the trigger with a reason.

POST/v1/actions/{actionId}/triggers

betaapiKeyworkspace

When to use

Run a published action automatically on a recurring UTC schedule.

For agents

Requires invocation permission and authority to delegate every capability the action declares (SDK permissions, connectors, and sources). The fixed input must match the published input contract. Runs act as the workspace system identity and do not recheck access. Each run rechecks input; a deleted or unpublished action, or input which no longer matches, disables the trigger with disabledReason. Missed slots run once, as the newest missed slot; skipped slots are recorded as a businessAction.trigger.skipped audit event.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.actionTriggers.create('actn_abcdefghijklmnopqrstuvwx', {
  "type": "schedule",
  "config": {
    "schedule": {
      "type": "daily",
      "hour": 9,
      "minute": 0
    },
    "input": {
      "region": "EMEA"
    }
  }
});

Request body

json

{
  "type": "schedule",
  "config": {
    "schedule": {
      "type": "daily",
      "hour": 9,
      "minute": 0
    },
    "input": {
      "region": "EMEA"
    }
  }
}

Response

json

{
  "data": {
    "id": "trig_abcdefghijklmnopqrstuvwx",
    "actionId": "actn_abcdefghijklmnopqrstuvwx",
    "workspaceId": "wksp_finance123",
    "type": "schedule",
    "config": {
      "schedule": {
        "type": "daily",
        "hour": 9,
        "minute": 0
      },
      "input": {
        "region": "EMEA"
      }
    },
    "isEnabled": true,
    "nextRunAt": "2026-10-03T09:00:00.000Z",
    "disabledReason": null,
    "createdAt": "2026-10-02T12:00:00.000Z",
    "updatedAt": "2026-10-02T12:00:00.000Z",
    "lastRun": null
  }
}