Skip to content
CrewhelmCrewhelmCrewhelm Docs

MCP Automations

Create and inspect Schedules and connected Event Triggers.

This reference is generated from Crewhelm’s authenticated MCP catalog and progressive operation schemas. Tool availability does not grant authority; every call is subject to the authenticated owner, approved OAuth scopes, and current control-plane policy.

Read tools

Section titled “Read tools”

Inspect state and obtain exact references without changing it.

crewhelm_inspect_automations

Section titled “crewhelm_inspect_automations”

Inspect Crewhelm automations

Inspect time-based responsibilities, event sources, and Event Trigger history without changing them.

Attributes: read-only, non-destructive, idempotent, closed-world.

How to use this tool:

  1. Send {"request":"operations"} to list its subtools.
  2. Send {"request":"schema","name":"…"} for one subtool’s exact inputs.
  3. Send {"request":"execute","name":"…","input":{…}} to run it.
Subtool Purpose
list_schedules List Schedules for one exact Agent.
inspect_schedule Inspect one exact Schedule.
event_sources List Event Trigger sources available through one exact Connection.
list_event_triggers List Event Triggers for one exact Agent.
inspect_event_trigger Inspect one exact Event Trigger.
event_history List bounded delivery history for one exact Event Trigger.

list_schedules

Section titled “list_schedules”

List Schedules for one exact Agent.

Input Required Type Details
agent Yes object Copy-ready Agent identity returned by Crewhelm.
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "agent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": {},
      "description": "Copy-ready Agent identity returned by Crewhelm."
    }
  },
  "required": [
    "agent"
  ],
  "additionalProperties": false
}

inspect_schedule

Section titled “inspect_schedule”

Inspect one exact Schedule.

Input Required Type Details
schedule Yes object —
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "id": {
          "type": "string",
          "pattern": "^schedule_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        }
      },
      "required": [
        "agentId",
        "id"
      ],
      "additionalProperties": {}
    }
  },
  "required": [
    "schedule"
  ],
  "additionalProperties": false
}

event_sources

Section titled “event_sources”

List Event Trigger sources available through one exact Connection.

Input Required Type Details
connection Yes object —
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "connection": {
      "type": "object",
      "properties": {
        "connectionId": {
          "type": "string",
          "pattern": "^connection_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        }
      },
      "required": [
        "connectionId"
      ],
      "additionalProperties": {}
    }
  },
  "required": [
    "connection"
  ],
  "additionalProperties": false
}

list_event_triggers

Section titled “list_event_triggers”

List Event Triggers for one exact Agent.

Input Required Type Details
agent Yes object Copy-ready Agent identity returned by Crewhelm.
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "agent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": {},
      "description": "Copy-ready Agent identity returned by Crewhelm."
    }
  },
  "required": [
    "agent"
  ],
  "additionalProperties": false
}

inspect_event_trigger

Section titled “inspect_event_trigger”

Inspect one exact Event Trigger.

Input Required Type Details
trigger Yes object —
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "trigger": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "id": {
          "type": "string",
          "pattern": "^event_trigger_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "description": "Opaque Event Trigger identity for exact lifecycle operations."
        }
      },
      "required": [
        "agentId",
        "id"
      ],
      "additionalProperties": {}
    }
  },
  "required": [
    "trigger"
  ],
  "additionalProperties": false
}

event_history

Section titled “event_history”

List bounded delivery history for one exact Event Trigger.

Input Required Type Details
limit No integer minimum: 1; maximum: 20
trigger Yes object —
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "trigger": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "id": {
          "type": "string",
          "pattern": "^event_trigger_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "description": "Opaque Event Trigger identity for exact lifecycle operations."
        }
      },
      "required": [
        "agentId",
        "id"
      ],
      "additionalProperties": {}
    }
  },
  "required": [
    "trigger"
  ],
  "additionalProperties": false
}

Write tools

Section titled “Write tools”

Preview or perform bounded changes under the required owner authority.

crewhelm_change_automations

Section titled “crewhelm_change_automations”

Change Crewhelm automations

Create or change recurring and connected-event responsibilities.

Attributes: write, destructive, idempotent, closed-world.

How to use this tool:

  1. Send {"request":"operations"} to list its subtools.
  2. Send {"request":"schema","name":"…"} for one subtool’s exact inputs.
  3. Send {"request":"execute","name":"…","input":{…}} to run it.
Subtool Purpose
create_schedule Create a recurring Schedule that starts Runs for one exact Agent revision.
update_schedule Replace an existing Schedule’s timing, instruction, Briefs, or output contract using its current revisions.
pause_schedule Stop an existing Schedule from starting Runs without deleting its definition.
create_event_trigger Create an Event Trigger that starts Runs from matching connected-app events for one exact Agent revision.
update_event_trigger Replace an existing Event Trigger definition using its current Agent and trigger revisions.
pause_event_trigger Stop an existing Event Trigger from starting Runs without deleting its definition.
resume_event_trigger Resume a paused Event Trigger so matching connected-app events can start Runs again.
delete_event_trigger Permanently delete one exact Event Trigger revision.

create_schedule

Section titled “create_schedule”

Create a recurring Schedule that starts Runs for one exact Agent revision.

Input Required Type Details
schedule Yes object —
agent Yes object Copy-ready Agent identity and immutable revision returned by Crewhelm.
requestKey No string Optional retry identity. Omit it on the ordinary happy path. minimum length: 1; maximum length: 128; pattern: ^[A-Za-z0-9._~-]+$
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "briefs": {
          "maxItems": 8,
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                  },
                  "revision": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100
                  }
                },
                "required": [
                  "id",
                  "revision"
                ],
                "additionalProperties": {}
              },
              {
                "type": "object",
                "properties": {
                  "currentRevision": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100
                  },
                  "id": {
                    "type": "string",
                    "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                  }
                },
                "required": [
                  "currentRevision",
                  "id"
                ],
                "additionalProperties": {}
              },
              {
                "type": "object",
                "properties": {
                  "brief": {
                    "type": "object",
                    "properties": {
                      "currentRevision": {
                        "type": "integer",
                        "exclusiveMinimum": 0,
                        "maximum": 100
                      },
                      "id": {
                        "type": "string",
                        "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                      }
                    },
                    "required": [
                      "currentRevision",
                      "id"
                    ],
                    "additionalProperties": {}
                  }
                },
                "required": [
                  "brief"
                ],
                "additionalProperties": {}
              }
            ],
            "description": "Copy-ready Brief reference, summary, or create result returned by Crewhelm."
          },
          "description": "Copy-ready immutable Briefs returned by Crewhelm."
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80,
          "description": "Short owner-facing name for this scheduled responsibility."
        },
        "outputContract": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "markdown"
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "json"
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "jsonSchema": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {},
                      "description": "Restricted object-root JSON Schema: scalar, array, and nested object types; required, enum, and basic bounds; additionalProperties must be false. Remote references, recursion, patterns, and composition are unsupported."
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 64,
                      "pattern": "^[A-Za-z][A-Za-z0-9_-]*$"
                    },
                    "version": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32,
                      "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
                    }
                  },
                  "required": [
                    "jsonSchema",
                    "name",
                    "version"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "kind",
                "schema"
              ],
              "additionalProperties": false
            }
          ],
          "description": "Optional bounded Markdown or typed JSON output contract."
        },
        "prompt": {
          "type": "string",
          "minLength": 1,
          "maxLength": 16384,
          "description": "Bounded Run instruction used for every occurrence."
        },
        "trigger": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "intervalSeconds": {
                  "type": "integer",
                  "minimum": 60,
                  "maximum": 604800,
                  "description": "Elapsed seconds between Runs; the first Run occurs one interval after creation."
                },
                "type": {
                  "type": "string",
                  "const": "interval"
                }
              },
              "required": [
                "intervalSeconds",
                "type"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "at": {
                  "type": "string",
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "description": "Local wall-clock time in 24-hour HH:mm form."
                },
                "frequency": {
                  "type": "string",
                  "const": "daily"
                },
                "timeZone": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128,
                  "pattern": "^(?:UTC|[A-Za-z0-9._+-]+(?:\\/[A-Za-z0-9._+-]+)+)$",
                  "description": "IANA time zone used to preserve local wall-clock time across offset changes."
                },
                "type": {
                  "type": "string",
                  "const": "calendar"
                }
              },
              "required": [
                "at",
                "frequency",
                "timeZone",
                "type"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "at": {
                  "type": "string",
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "description": "Local wall-clock time in 24-hour HH:mm form."
                },
                "daysOfWeek": {
                  "minItems": 1,
                  "maxItems": 7,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "monday",
                      "tuesday",
                      "wednesday",
                      "thursday",
                      "friday",
                      "saturday",
                      "sunday"
                    ]
                  },
                  "description": "Execution weekdays, unique and ordered Monday through Sunday."
                },
                "frequency": {
                  "type": "string",
                  "const": "weekly"
                },
                "timeZone": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128,
                  "pattern": "^(?:UTC|[A-Za-z0-9._+-]+(?:\\/[A-Za-z0-9._+-]+)+)$",
                  "description": "IANA time zone used to preserve local wall-clock time across offset changes."
                },
                "type": {
                  "type": "string",
                  "const": "calendar"
                }
              },
              "required": [
                "at",
                "daysOfWeek",
                "frequency",
                "timeZone",
                "type"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "at": {
                  "type": "string",
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "description": "Local wall-clock time in 24-hour HH:mm form."
                },
                "dayOfMonth": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 31,
                  "description": "Local calendar day; months without this day are skipped."
                },
                "frequency": {
                  "type": "string",
                  "const": "monthly"
                },
                "timeZone": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128,
                  "pattern": "^(?:UTC|[A-Za-z0-9._+-]+(?:\\/[A-Za-z0-9._+-]+)+)$",
                  "description": "IANA time zone used to preserve local wall-clock time across offset changes."
                },
                "type": {
                  "type": "string",
                  "const": "calendar"
                }
              },
              "required": [
                "at",
                "dayOfMonth",
                "frequency",
                "timeZone",
                "type"
              ],
              "additionalProperties": false
            }
          ]
        }
      },
      "required": [
        "name",
        "prompt",
        "trigger"
      ],
      "additionalProperties": false
    },
    "agent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "id",
        "revision"
      ],
      "additionalProperties": {},
      "description": "Copy-ready Agent identity and immutable revision returned by Crewhelm."
    },
    "requestKey": {
      "description": "Optional retry identity. Omit it on the ordinary happy path.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9._~-]+$"
    }
  },
  "required": [
    "schedule",
    "agent"
  ],
  "additionalProperties": false
}

update_schedule

Section titled “update_schedule”

Replace an existing Schedule’s timing, instruction, Briefs, or output contract using its current revisions.

Input Required Type Details
definition Yes object —
schedule Yes object —
requestKey No string Optional retry identity. Omit it on the ordinary happy path. minimum length: 1; maximum length: 128; pattern: ^[A-Za-z0-9._~-]+$
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "definition": {
      "type": "object",
      "properties": {
        "briefs": {
          "maxItems": 8,
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                  },
                  "revision": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100
                  }
                },
                "required": [
                  "id",
                  "revision"
                ],
                "additionalProperties": {}
              },
              {
                "type": "object",
                "properties": {
                  "currentRevision": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100
                  },
                  "id": {
                    "type": "string",
                    "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                  }
                },
                "required": [
                  "currentRevision",
                  "id"
                ],
                "additionalProperties": {}
              },
              {
                "type": "object",
                "properties": {
                  "brief": {
                    "type": "object",
                    "properties": {
                      "currentRevision": {
                        "type": "integer",
                        "exclusiveMinimum": 0,
                        "maximum": 100
                      },
                      "id": {
                        "type": "string",
                        "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                      }
                    },
                    "required": [
                      "currentRevision",
                      "id"
                    ],
                    "additionalProperties": {}
                  }
                },
                "required": [
                  "brief"
                ],
                "additionalProperties": {}
              }
            ],
            "description": "Copy-ready Brief reference, summary, or create result returned by Crewhelm."
          },
          "description": "Copy-ready immutable Briefs returned by Crewhelm."
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80,
          "description": "Short owner-facing name for this scheduled responsibility."
        },
        "outputContract": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "markdown"
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "json"
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "jsonSchema": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {},
                      "description": "Restricted object-root JSON Schema: scalar, array, and nested object types; required, enum, and basic bounds; additionalProperties must be false. Remote references, recursion, patterns, and composition are unsupported."
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 64,
                      "pattern": "^[A-Za-z][A-Za-z0-9_-]*$"
                    },
                    "version": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32,
                      "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
                    }
                  },
                  "required": [
                    "jsonSchema",
                    "name",
                    "version"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "kind",
                "schema"
              ],
              "additionalProperties": false
            }
          ],
          "description": "Optional bounded Markdown or typed JSON output contract."
        },
        "prompt": {
          "type": "string",
          "minLength": 1,
          "maxLength": 16384,
          "description": "Bounded Run instruction used for every occurrence."
        },
        "trigger": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "intervalSeconds": {
                  "type": "integer",
                  "minimum": 60,
                  "maximum": 604800,
                  "description": "Elapsed seconds between Runs; the first Run occurs one interval after creation."
                },
                "type": {
                  "type": "string",
                  "const": "interval"
                }
              },
              "required": [
                "intervalSeconds",
                "type"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "at": {
                  "type": "string",
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "description": "Local wall-clock time in 24-hour HH:mm form."
                },
                "frequency": {
                  "type": "string",
                  "const": "daily"
                },
                "timeZone": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128,
                  "pattern": "^(?:UTC|[A-Za-z0-9._+-]+(?:\\/[A-Za-z0-9._+-]+)+)$",
                  "description": "IANA time zone used to preserve local wall-clock time across offset changes."
                },
                "type": {
                  "type": "string",
                  "const": "calendar"
                }
              },
              "required": [
                "at",
                "frequency",
                "timeZone",
                "type"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "at": {
                  "type": "string",
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "description": "Local wall-clock time in 24-hour HH:mm form."
                },
                "daysOfWeek": {
                  "minItems": 1,
                  "maxItems": 7,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "monday",
                      "tuesday",
                      "wednesday",
                      "thursday",
                      "friday",
                      "saturday",
                      "sunday"
                    ]
                  },
                  "description": "Execution weekdays, unique and ordered Monday through Sunday."
                },
                "frequency": {
                  "type": "string",
                  "const": "weekly"
                },
                "timeZone": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128,
                  "pattern": "^(?:UTC|[A-Za-z0-9._+-]+(?:\\/[A-Za-z0-9._+-]+)+)$",
                  "description": "IANA time zone used to preserve local wall-clock time across offset changes."
                },
                "type": {
                  "type": "string",
                  "const": "calendar"
                }
              },
              "required": [
                "at",
                "daysOfWeek",
                "frequency",
                "timeZone",
                "type"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "at": {
                  "type": "string",
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "description": "Local wall-clock time in 24-hour HH:mm form."
                },
                "dayOfMonth": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 31,
                  "description": "Local calendar day; months without this day are skipped."
                },
                "frequency": {
                  "type": "string",
                  "const": "monthly"
                },
                "timeZone": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128,
                  "pattern": "^(?:UTC|[A-Za-z0-9._+-]+(?:\\/[A-Za-z0-9._+-]+)+)$",
                  "description": "IANA time zone used to preserve local wall-clock time across offset changes."
                },
                "type": {
                  "type": "string",
                  "const": "calendar"
                }
              },
              "required": [
                "at",
                "dayOfMonth",
                "frequency",
                "timeZone",
                "type"
              ],
              "additionalProperties": false
            }
          ]
        }
      },
      "required": [
        "name",
        "prompt",
        "trigger"
      ],
      "additionalProperties": false
    },
    "schedule": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "agentRevision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "id": {
          "type": "string",
          "pattern": "^schedule_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "agentId",
        "agentRevision",
        "id",
        "revision"
      ],
      "additionalProperties": {}
    },
    "requestKey": {
      "description": "Optional retry identity. Omit it on the ordinary happy path.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9._~-]+$"
    }
  },
  "required": [
    "definition",
    "schedule"
  ],
  "additionalProperties": false
}

pause_schedule

Section titled “pause_schedule”

Stop an existing Schedule from starting Runs without deleting its definition.

Input Required Type Details
schedule Yes object —
requestKey No string Optional retry identity. Omit it on the ordinary happy path. minimum length: 1; maximum length: 128; pattern: ^[A-Za-z0-9._~-]+$
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "agentRevision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "id": {
          "type": "string",
          "pattern": "^schedule_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "agentId",
        "agentRevision",
        "id",
        "revision"
      ],
      "additionalProperties": {}
    },
    "requestKey": {
      "description": "Optional retry identity. Omit it on the ordinary happy path.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9._~-]+$"
    }
  },
  "required": [
    "schedule"
  ],
  "additionalProperties": false
}

create_event_trigger

Section titled “create_event_trigger”

Create an Event Trigger that starts Runs from matching connected-app events for one exact Agent revision.

Input Required Type Details
eventTrigger Yes object —
agent Yes object Copy-ready Agent identity and immutable revision returned by Crewhelm.
requestKey No string Optional retry identity. Omit it on the ordinary happy path. minimum length: 1; maximum length: 128; pattern: ^[A-Za-z0-9._~-]+$
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventTrigger": {
      "type": "object",
      "properties": {
        "briefs": {
          "maxItems": 8,
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                  },
                  "revision": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100
                  }
                },
                "required": [
                  "id",
                  "revision"
                ],
                "additionalProperties": {}
              },
              {
                "type": "object",
                "properties": {
                  "currentRevision": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100
                  },
                  "id": {
                    "type": "string",
                    "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                  }
                },
                "required": [
                  "currentRevision",
                  "id"
                ],
                "additionalProperties": {}
              },
              {
                "type": "object",
                "properties": {
                  "brief": {
                    "type": "object",
                    "properties": {
                      "currentRevision": {
                        "type": "integer",
                        "exclusiveMinimum": 0,
                        "maximum": 100
                      },
                      "id": {
                        "type": "string",
                        "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                      }
                    },
                    "required": [
                      "currentRevision",
                      "id"
                    ],
                    "additionalProperties": {}
                  }
                },
                "required": [
                  "brief"
                ],
                "additionalProperties": {}
              }
            ],
            "description": "Copy-ready Brief reference, summary, or create result returned by Crewhelm."
          },
          "description": "Copy-ready immutable Briefs returned by Crewhelm."
        },
        "connectionId": {
          "type": "string",
          "pattern": "^connection_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "description": "Connected account returned by sources."
        },
        "delivery": {
          "type": "string",
          "enum": [
            "provider_polling",
            "realtime"
          ],
          "description": "Delivery returned by sources."
        },
        "eventSlug": {
          "type": "string",
          "pattern": "^[A-Z0-9][A-Z0-9_]{0,255}$",
          "description": "Event slug returned by sources."
        },
        "eventVersion": {
          "type": "string",
          "pattern": "^[0-9]{8}_[0-9]{2}$",
          "description": "Event version returned by sources."
        },
        "filters": {
          "type": "object",
          "propertyNames": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "additionalProperties": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "number"
              },
              {
                "type": "string",
                "maxLength": 2048
              }
            ]
          },
          "description": "Event filters described by the source."
        },
        "integrationSlug": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9_-]{0,127}$",
          "description": "Integration returned by sources."
        },
        "instruction": {
          "type": "string",
          "minLength": 1,
          "maxLength": 16384,
          "description": "The Agent's responsibility for each matching event."
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80,
          "description": "Short owner-facing name for this Event Trigger."
        },
        "outputContract": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "markdown"
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "json"
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "jsonSchema": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {},
                      "description": "Restricted object-root JSON Schema: scalar, array, and nested object types; required, enum, and basic bounds; additionalProperties must be false. Remote references, recursion, patterns, and composition are unsupported."
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 64,
                      "pattern": "^[A-Za-z][A-Za-z0-9_-]*$"
                    },
                    "version": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32,
                      "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
                    }
                  },
                  "required": [
                    "jsonSchema",
                    "name",
                    "version"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "kind",
                "schema"
              ],
              "additionalProperties": false
            }
          ],
          "description": "Optional bounded Markdown or typed JSON output contract."
        }
      },
      "required": [
        "connectionId",
        "delivery",
        "eventSlug",
        "eventVersion",
        "filters",
        "integrationSlug",
        "instruction",
        "name"
      ],
      "additionalProperties": false
    },
    "agent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "id",
        "revision"
      ],
      "additionalProperties": {},
      "description": "Copy-ready Agent identity and immutable revision returned by Crewhelm."
    },
    "requestKey": {
      "description": "Optional retry identity. Omit it on the ordinary happy path.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9._~-]+$"
    }
  },
  "required": [
    "eventTrigger",
    "agent"
  ],
  "additionalProperties": false
}

update_event_trigger

Section titled “update_event_trigger”

Replace an existing Event Trigger definition using its current Agent and trigger revisions.

Input Required Type Details
definition Yes object —
trigger Yes object —
requestKey No string Optional retry identity. Omit it on the ordinary happy path. minimum length: 1; maximum length: 128; pattern: ^[A-Za-z0-9._~-]+$
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "definition": {
      "type": "object",
      "properties": {
        "briefs": {
          "maxItems": 8,
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                  },
                  "revision": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100
                  }
                },
                "required": [
                  "id",
                  "revision"
                ],
                "additionalProperties": {}
              },
              {
                "type": "object",
                "properties": {
                  "currentRevision": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100
                  },
                  "id": {
                    "type": "string",
                    "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                  }
                },
                "required": [
                  "currentRevision",
                  "id"
                ],
                "additionalProperties": {}
              },
              {
                "type": "object",
                "properties": {
                  "brief": {
                    "type": "object",
                    "properties": {
                      "currentRevision": {
                        "type": "integer",
                        "exclusiveMinimum": 0,
                        "maximum": 100
                      },
                      "id": {
                        "type": "string",
                        "pattern": "^brief_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
                      }
                    },
                    "required": [
                      "currentRevision",
                      "id"
                    ],
                    "additionalProperties": {}
                  }
                },
                "required": [
                  "brief"
                ],
                "additionalProperties": {}
              }
            ],
            "description": "Copy-ready Brief reference, summary, or create result returned by Crewhelm."
          },
          "description": "Copy-ready immutable Briefs returned by Crewhelm."
        },
        "connectionId": {
          "type": "string",
          "pattern": "^connection_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "description": "Connected account returned by sources."
        },
        "delivery": {
          "type": "string",
          "enum": [
            "provider_polling",
            "realtime"
          ],
          "description": "Delivery returned by sources."
        },
        "eventSlug": {
          "type": "string",
          "pattern": "^[A-Z0-9][A-Z0-9_]{0,255}$",
          "description": "Event slug returned by sources."
        },
        "eventVersion": {
          "type": "string",
          "pattern": "^[0-9]{8}_[0-9]{2}$",
          "description": "Event version returned by sources."
        },
        "filters": {
          "type": "object",
          "propertyNames": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "additionalProperties": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "number"
              },
              {
                "type": "string",
                "maxLength": 2048
              }
            ]
          },
          "description": "Event filters described by the source."
        },
        "integrationSlug": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9_-]{0,127}$",
          "description": "Integration returned by sources."
        },
        "instruction": {
          "type": "string",
          "minLength": 1,
          "maxLength": 16384,
          "description": "The Agent's responsibility for each matching event."
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80,
          "description": "Short owner-facing name for this Event Trigger."
        },
        "outputContract": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "markdown"
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "json"
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "jsonSchema": {
                      "type": "object",
                      "propertyNames": {
                        "type": "string"
                      },
                      "additionalProperties": {},
                      "description": "Restricted object-root JSON Schema: scalar, array, and nested object types; required, enum, and basic bounds; additionalProperties must be false. Remote references, recursion, patterns, and composition are unsupported."
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 64,
                      "pattern": "^[A-Za-z][A-Za-z0-9_-]*$"
                    },
                    "version": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 32,
                      "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
                    }
                  },
                  "required": [
                    "jsonSchema",
                    "name",
                    "version"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "kind",
                "schema"
              ],
              "additionalProperties": false
            }
          ],
          "description": "Optional bounded Markdown or typed JSON output contract."
        }
      },
      "required": [
        "connectionId",
        "delivery",
        "eventSlug",
        "eventVersion",
        "filters",
        "integrationSlug",
        "instruction",
        "name"
      ],
      "additionalProperties": false
    },
    "trigger": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "agentRevision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "id": {
          "type": "string",
          "pattern": "^event_trigger_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "description": "Opaque Event Trigger identity for exact lifecycle operations."
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "agentId",
        "agentRevision",
        "id",
        "revision"
      ],
      "additionalProperties": {}
    },
    "requestKey": {
      "description": "Optional retry identity. Omit it on the ordinary happy path.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9._~-]+$"
    }
  },
  "required": [
    "definition",
    "trigger"
  ],
  "additionalProperties": false
}

pause_event_trigger

Section titled “pause_event_trigger”

Stop an existing Event Trigger from starting Runs without deleting its definition.

Input Required Type Details
trigger Yes object —
requestKey No string Optional retry identity. Omit it on the ordinary happy path. minimum length: 1; maximum length: 128; pattern: ^[A-Za-z0-9._~-]+$
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "trigger": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "agentRevision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "id": {
          "type": "string",
          "pattern": "^event_trigger_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "description": "Opaque Event Trigger identity for exact lifecycle operations."
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "agentId",
        "agentRevision",
        "id",
        "revision"
      ],
      "additionalProperties": {}
    },
    "requestKey": {
      "description": "Optional retry identity. Omit it on the ordinary happy path.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9._~-]+$"
    }
  },
  "required": [
    "trigger"
  ],
  "additionalProperties": false
}

resume_event_trigger

Section titled “resume_event_trigger”

Resume a paused Event Trigger so matching connected-app events can start Runs again.

Input Required Type Details
trigger Yes object —
requestKey No string Optional retry identity. Omit it on the ordinary happy path. minimum length: 1; maximum length: 128; pattern: ^[A-Za-z0-9._~-]+$
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "trigger": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "agentRevision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "id": {
          "type": "string",
          "pattern": "^event_trigger_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "description": "Opaque Event Trigger identity for exact lifecycle operations."
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "agentId",
        "agentRevision",
        "id",
        "revision"
      ],
      "additionalProperties": {}
    },
    "requestKey": {
      "description": "Optional retry identity. Omit it on the ordinary happy path.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9._~-]+$"
    }
  },
  "required": [
    "trigger"
  ],
  "additionalProperties": false
}

delete_event_trigger

Section titled “delete_event_trigger”

Permanently delete one exact Event Trigger revision.

Input Required Type Details
trigger Yes object —
requestKey No string Optional retry identity. Omit it on the ordinary happy path. minimum length: 1; maximum length: 128; pattern: ^[A-Za-z0-9._~-]+$
View exact JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "trigger": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string",
          "pattern": "^agent_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
        },
        "agentRevision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "id": {
          "type": "string",
          "pattern": "^event_trigger_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
          "description": "Opaque Event Trigger identity for exact lifecycle operations."
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "agentId",
        "agentRevision",
        "id",
        "revision"
      ],
      "additionalProperties": {}
    },
    "requestKey": {
      "description": "Optional retry identity. Omit it on the ordinary happy path.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9._~-]+$"
    }
  },
  "required": [
    "trigger"
  ],
  "additionalProperties": false
}