Worker REST API

The worker is, technically, an HTTP server. The platform calls into it whenever it needs to run a node, list available components, test a connector, or kick off the OAuth handshake. Both the Node.js and PHP SDKs implement the same routes, so the wire contract below applies to both.

You don't usually need to think about these routes: they are wired up by the SDK and the bundle. This page exists for the cases where you do, for example when you put a reverse proxy in front of the worker or when you debug an integration test.

Discovery #

Method	Route	Purpose
`GET`	`/applications`	List all Applications registered in this worker.
`GET`	`/applications/{key}`	Application detail (name, description, form definition).
`GET`	`/connector/list`	List all Connectors.
`GET`	`/custom_node/list`	List all custom nodes.
`GET`	`/batch/list`	List all batch nodes.

The platform calls discovery routes once at worker start (and on demand from the Admin UI) to know which components are available.

Execution #

Method	Route	Purpose
`POST`	`/connector/{id}/action`	Run one connector against an inbound message.
`POST`	`/custom_node/{id}/process`	Run one custom node against an inbound message.
`POST`	`/batch/{key}/action`	Run one batch node iteration.

These are the routes the platform calls during topology execution. The request body is the inbound ProcessDto; the response is the outbound ProcessDto.

Test endpoints #

Method	Route	Purpose
`GET`	`/connector/{id}/action/test`	Health-check this connector (does it even resolve)?
`GET`	`/custom_node/{id}/process/test`	Same for a custom node.
`GET`	`/batch/{key}/action/test`	Same for a batch node.

The Admin UI's "test" buttons call these routes.

Application sync calls #

Method	Route	Purpose
`GET`	`/applications/{key}/sync/list`	List the synchronous methods the Application exposes.
`GET, POST`	`/applications/{key}/sync/{method}`	Invoke one synchronous method (used for in-Admin lookups, e.g. populating a select box from upstream).

OAuth handshake #

Method	Route	Purpose
`GET`	`/applications/{key}/users/{user}/sdk/{sdk}/authorize`	Build the authorize URL the user is redirected to.
`GET`	`/applications/{key}/users/{user}/sdk/{sdk}/authorize/token`	Callback target the provider returns to.
`GET`	`/applications/authorize/token`	Generic OAuth callback variant.

Source of truth #

For the canonical machine-readable definition with full request/response shapes, consult the OpenAPI files shipped with each SDK:

Node.js: openapi.yaml in @orchesty/nodejs-sdk.
PHP: openapi.yaml in orchesty/php-sdk.