Webhooks API reference

Webhooks API.

8 endpoints, 4 of them read-only. Every one is also a command in the orbit CLI, a method in the SDKs and a tool on the MCP server.

01

General

EndpointScopeParametersCLI · MCP tool
GET /webhooks
List webhook endpoints
read?limit integer
?offset integer
orbit webhooks list
webhooks_list
POST /webhooks
Register an endpoint (max 10)
writebody: url* string, events string[], note stringorbit webhooks create
webhooks_create
GET /webhooks/{id}
Get an endpoint
readid integerorbit webhooks get <id>
webhooks_get
PATCH /webhooks/{id}
Update an endpoint
writeid integer
body: url string, events string[], enabled boolean, note string
orbit webhooks patch <id>
webhooks_patch
DELETE /webhooks/{id}
Delete an endpoint
writeid integerorbit webhooks delete <id>
webhooks_delete
POST /webhooks/{id}/test
Send a ping event now
writeid integerorbit webhooks test <id>
webhooks_test
GET /webhooks/{id}/deliveries
Recent deliveries for an endpoint
readid integer
?limit integer
?offset integer
orbit webhooks deliveries <id>
webhooks_deliveries
GET /webhook-events
Event names an endpoint can subscribe to
read—orbit webhooks events
webhooks_events
Next

Related

Account API reference

Every Account endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Organization API reference

Every Organization endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Services API reference

Every Services endpoint in the Orbit API (15): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

← All documentation