Skip to content
GurtOS docs

Call an app's webhook

POST
/hook/{app}/{name}
curl --request POST \
  --url http://127.0.0.1:7700/hook/example/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "From a webhook" }'

Runs the webhook an app registered with the webhook trigger (or box.onWebhook). The JSON body and the headers go to the app, which usually starts a task. The response is the new task, or {"ok": true} when the app returns nothing. This route has no /api form. From outside the box it needs a device token like any other route.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
app
required
string

The app’s name.

Example 

example
name
required
string
/^[\w-]+$/

The webhook’s name, letters, digits, _ and -.

Example 

start

Request Body

Section titled “Request Body”
Media typeapplication/json
object

Example 

{
  "title": "From a webhook"
}

Responses

Section titled “Responses”

200

Section titled “200”

What the app returned.

Media typeapplication/json
One of:
object
title
required

A short name for people.

string
prompt
required

What the worker should do. For the fake worker, one command per line.

string
workspace
required

A folder in BOX_HOME/workspaces. The task works on its own copy of it.

string
default: home /^[\w.-]+$/
worker
required

droid is Droid with Claude. fake runs scripted steps with no model, for tests.

string
default: droid
Allowed values: droid fake
tools
required

Tool names the task may call through its broker, such as wallet.pay.

Array<string>
default:
hosts
required

Hosts the task’s network may reach: example.com (any port), example.com:8080 (one port) or *.example.com (subdomains).

Array<string>
default:
budgetCents
required

Spending above this, in US cents, pauses the task for an OK. Default Settings defaultBudgetCents, 0 unless changed.

number
source
required

Who started it, for the log and the portal: api, schedule, asi1, jira:BOX-12.

string
default: api
folder

Personal: the first real folder the task works on a copy of.

string
folders

Personal: every real folder the task works on.

Array<string>
id
required
string
state
required

queued created, not started. running the worker is working. waiting paused until an approval is answered. done finished; its changes are part of the workspace. failed stopped with an error; its changes are not applied. undone removed; its changes are gone and other tasks keep theirs.

string
Allowed values: queued running waiting done failed undone
user
required

The Linux user the task runs as, box-<id>.

string
layers
required

Finished tasks whose changes this task saw when it started, newest first.

Array<string>
costCents
required

Tool spending plus model cost, in US cents. Not rounded.

number
step

The latest step

string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
error

Why it failed. A worker that exited with an error ends with its own last error line: worker exited with 1: Error: ....

string
summary
string
review

Personal, for a task on real folders: done and waiting for the owner, kept, stopped by a conflict, or undone.

string
Allowed values: pending kept conflict undone

Example 

{
  "workspace": "home",
  "worker": "droid",
  "tools": [],
  "hosts": [],
  "source": "api",
  "id": "t3k9x2a1b2",
  "state": "queued",
  "user": "box-t3k9x2a1b2",
  "review": "pending"
}

400

Section titled “400”

The app’s handler failed or the body was not JSON.

Media typeapplication/json
object
error
required

What went wrong

string

Example generated

{
  "error": "example"
}

GurtOS is open source under the Apache License 2.0.Source code on GitHub.