Signals API

List Event Gateway signals

DP-initiated signal fetch.

The DP supplies:

  • X-Node-Id and X-Node-Version as HTTP headers
  • capabilities as a deepObject query parameter:
    • Keys are capability names (e.g. config_sync)
    • Values contain the capability request fields (version, optional offset)

Example:
GET /event-gateway-signals/{gatewayId}?capabilities[config_sync][version]=v1&capabilities[config_sync][offset]=v0.0
X-Node-Id: 226db49d-0198-4bc5-ab74-8bb4f5de3a43
X-Node-Version: 1.0.0

The CP responds with a JSON payload containing zero or more signals that the DP should process.
If no signals are available, the CP responds with HTTP 304 Not Modified.

get

Query Parameters

capabilitiesobject

Map of capability name -> capability request fields.

Example:
{
“config_sync”: { “version”: “v1”, “offset”: “v0.0” }
}

Example:{"config_sync":{"version":"v1","offset":"v0.0"}}

Path Parameters

gatewayIdstring(uuid)required

The ID of the gateway.

Headers

X-Node-Idstring(uuid)required

The ID of the node.

X-Node-Versionstringrequired

The string representation of the node version.

Response

application/json

The gateway signals response.

EventGatewaySignals

The gateway signals response.

signalsOne Of
arrayrequired

A single signal envelope containing exactly one typed capability signal.

ConfigSyncSignalV1object

Signal notifying the DP that config has changed.

parameters contains capability-specific notification details.
For config_sync, that includes data-channel endpoints the DP can call to fetch config.

* Additional properties are NOT allowed.
Show Child Parameters
get/event-gateway-signals/{gatewayId}
 
application/json

Identify node to CP

DP-initiated node identification.

The CP responds with HTTP 200 OK if the node is successfully identified, containing the org and cp information.

post

Response

application/json

Node successfully identified

IdentifyNodeResponse

Response payload for successful node identification.

organization_idstring(uuid)required

The ID of the organization the node belongs to.

control_plane_idstring(uuid)required

The ID of the control plane the node is connecting to.

post/me
 
application/json

IdentifyNodeResponse

object

Response payload for successful node identification.

organization_idstring(uuid)required

The ID of the organization the node belongs to.

control_plane_idstring(uuid)required

The ID of the control plane the node is connecting to.

Example

CapabilityVersion

string

Capability-defined monotonic version.

Allowed values:v1