Skip to main content
POST
Call jobs.set_webhook

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
url
string
required

The https URL to announce completed jobs to. It must name a public host on the default port, with no user name, password or fragment.

Required string length: 1 - 2048
signing_secret
string
required

A secret you choose and keep, 32 to 256 printable characters with no spaces. Every delivery is signed with it: x-goosy-signature: t=,v1=<hex HMAC-SHA256 of ".">. It is never shown back.

Pattern: ^[\x21-\x7e]{32,256}$
workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
webhook_id
string
required

The webhook's id.

url
string
required

The URL completed jobs are announced to.

state
enum<string>
required

registered — this call created the workspace's webhook; replaced — it already existed, and its URL and secret are now these.

Available options:
registered,
replaced
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.