Storyden
Trails

Create a Trail

Create a Trail with one trigger and one or more action bindings. The server records the requesting account as the creator and validates the trigger, actions, and lifecycle state. An active Trail receives its next occurrence when the trigger has a future occurrence.

POST/trails

Create a Trail with one trigger and one or more action bindings. The server records the requesting account as the creator and validates the trigger, actions, and lifecycle state. An active Trail receives its next occurrence when the trigger has a future occurrence.

Authorization

storyden-session<token>

In: cookie

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/trails" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "status": "active",    "trigger": {      "type": "schedule",      "schedule": {        "start": "2026-08-18T10:00:00",        "timezone": "string",        "rule": {          "frequency": "hourly",          "interval": 1        }      }    },    "actions": [      {        "type": "robot_run",        "robot_ref": "string",        "instruction": "string"      }    ]  }'
{
  "id": "cc5lnd2s1s4652adtu50",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "misc": {},
  "name": "string",
  "description": "string",
  "created_by": {
    "id": "cc5lnd2s1s4652adtu50",
    "joined": "2019-08-24T14:15:22Z",
    "suspended": "2019-08-24T14:15:22Z",
    "handle": "Southclaws",
    "name": "Barnaby Keene",
    "signature": "<body><p>Sent with love from London!</p></body>",
    "roles": [
      {
        "badge": true,
        "default": true,
        "id": "cc5lnd2s1s4652adtu50",
        "name": "string",
        "colour": "string",
        "meta": {}
      }
    ]
  },
  "status": "active",
  "trigger": {
    "type": "schedule",
    "schedule": {
      "start": "2026-08-18T10:00:00",
      "timezone": "string",
      "rule": {
        "frequency": "hourly",
        "interval": 1,
        "by_weekday": [
          "monday"
        ],
        "by_month": [
          1
        ],
        "by_month_day": [
          -31
        ],
        "count": 1
      }
    }
  },
  "actions": [
    {
      "id": "cc5lnd2s1s4652adtu50",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "deletedAt": "2019-08-24T14:15:22Z",
      "misc": {},
      "action": {
        "type": "robot_run",
        "robot_ref": "string",
        "instruction": "string"
      }
    }
  ],
  "next_occurrence_at": "2019-08-24T14:15:22Z",
  "last_occurrence_at": "2019-08-24T14:15:22Z"
}
Empty
Empty
Empty
{
  "type": "string",
  "title": "string",
  "detail": "string",
  "trace_id": "string",
  "metadata": {}
}
Edit on GitHub

Cancel an active Robot action PUT

Request cancellation for one queued or running Robot action. A queued action is cancelled before it starts. A running action forwards the cancellation request to the Robot session coordinator. Other action runs in the same Trail run continue independently.

Get a Trail GET

Return one Trail definition. The response includes the current trigger, active action bindings, lifecycle state, and occurrence times. The operation does not return run history.