Automation and team
Routines, webhook triggers, hand-offs and incidents.
Routines
| Method | Path | Body | Returns |
|---|---|---|---|
GET |
/routines |
Routine[], each with nextRun and a readable summary |
|
PUT |
/routines |
Routine |
The saved Routine. An empty id creates one. |
DELETE |
/routines/{id} |
204 |
|
POST |
/routines/{id}/run |
{} |
{ turnId, message }. Runs it now; its schedule stays. |
{
"id": "",
"name": "Morning summary",
"botId": "scout",
"instructions": "Summarize yesterday's new issues and anything assigned to me.",
"schedule": "Weekdays",
"time": "08:00",
"timeLimitMinutes": 15,
"continuity": true
}
schedule |
Uses |
|---|---|
Once |
at (local date and time) |
Daily, Weekdays |
time (HH:mm, the server's local time) |
Weekly |
time and days (0 = Sunday … 6 = Saturday) |
Monthly |
time and dayOfMonth |
Interval |
everyMinutes |
Webhook triggers
| Method | Path | Body | Returns |
|---|---|---|---|
GET |
/triggers |
Trigger[], each with its url |
|
PUT |
/triggers |
Trigger |
The saved Trigger. An empty id creates one and makes its secret. |
DELETE |
/triggers/{id} |
204 |
|
POST |
/triggers/{id}/secret |
{} |
{ "value": "<secret>" }. Add ?renew=true to replace it; the old one stops working at once. |
POST |
/triggers/{id}/test |
{} |
{ "value": "<what a sender would be told>" }. Runs it with a sample request. |
{ "id": "", "name": "New GitHub issues", "botId": "scout", "instructions": "Triage the issue: label it and suggest an owner.", "events": ["issues"] }
Senders call POST /hooks/{id} (no access token): see Webhook triggers for how they prove the secret and what they get back.
Hand-offs
| Method | Path | Returns |
|---|---|---|
GET |
/handoffs |
Handoff[]: open ones and the most recent finished ones |
DELETE |
/handoffs/{id} |
204. Stops a queued or running hand-off. |
A hand-off's status is Queued, Working, Done, Failed or Stopped, and result or error says how it went.
Incidents
| Method | Path | Body | Returns |
|---|---|---|---|
GET |
/incidents |
Incident[], open ones first |
|
POST |
/incidents/{id} |
{ "action": "retry" } |
204 |
action is retry, dismiss, or reassign with a botId.
Used by the app
These endpoints carry the app's own traffic between machines. Don't call them yourself: /handoffs/receive, /handoffs/complete, /handoffs/stop, /app/attach, /team/approvals, /browser/{id} and /computer-answers/{id}.