---
title: "EventGatewaySignals"
url: "https://nov18-dev.movespot.fyi/apis/gateway-admin-signals-dev-0/versions/e2254c09-056a-40a6-96db-b4f4a9e798b8/schemas/EventGatewaySignals"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/gateway-admin-signals-dev-0/versions/e2254c09-056a-40a6-96db-b4f4a9e798b8.md

# EventGatewaySignals

The gateway signals response.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Gateway Admin Signals
  version: 0.1.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    EventGatewaySignal:
      description: A single signal envelope containing exactly one typed capability signal.
      discriminator:
        propertyName: type
        mapping:
          config_sync: "#/components/schemas/ConfigSyncSignalV1"
      oneOf:
        - $ref: "#/components/schemas/ConfigSyncSignalV1"
      x-rust-attrs:
        - "#[derive(derive_more::Display, Debug, Clone, Serialize, Deserialize)]"
        - "#[non_exhaustive]"
    ConfigSyncSignalV1:
      description: >
        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.
      allOf:
        - $ref: "#/components/schemas/BaseCapabilityEnvelope"
        - type: object
          x-rust-attrs:
            - "#[derive(Debug, Clone, Serialize, Deserialize)]"
          additionalProperties: false
          required:
            - type
            - version
            - offset
            - parameters
          properties:
            type:
              type: string
              enum:
                - config_sync
              x-rust-attrs:
                - "#[derive(derive_more::Display, Debug, Clone, Serialize,
                  Deserialize)]"
            version:
              type: string
              enum:
                - v1
            parameters:
              $ref: "#/components/schemas/ConfigSyncV1Parameters"
      x-rust-attrs:
        - "#[derive(derive_more::Display, Debug, Clone, Serialize, Deserialize)]"
        - '#[display( "({} {:?} {} {} {})", version, correlation_id, r#type,
          parameters, offset)]'
    BaseCapabilityEnvelope:
      description: |
        Base envelope for all capability signals.
        Contains fields common to all capability signals.
      type: object
      properties:
        type:
          description: The signal type identifier.
          type: string
        version:
          description: The capability schema version for this signal type.
          type: string
        offset:
          $ref: "#/components/schemas/CapabilityOffset"
        correlation_id:
          description: Optional correlation id for tracing/debugging.
          type: string
        parameters:
          description: Optional map of additional parameters for future use.
          additionalProperties: true
          type: object
      required:
        - type
        - version
        - offset
    ConfigSyncV1Parameters:
      type: object
      properties:
        endpoint_prefix:
          $ref: "#/components/schemas/EndpointPrefixRef"
      additionalProperties: false
      required:
        - endpoint_prefix
      x-rust-attrs:
        - "#[derive(derive_more::Display, Debug, Clone, Serialize, Deserialize)]"
        - '#[display("({:?})", endpoint_prefix)]'
    CapabilityOffset:
      description: Capability-defined monotonic offset.
      type: string
      format: offset
      x-rust-type: String
    EndpointPrefixRef:
      description: Relative URI the DP should call to interact with capability workers.
      type: string
      example: /v1/event-gateway-data-planes/<cp-id>
      x-rust-type: String
    EventGatewaySignals:
      description: The gateway signals response.
      type: object
      properties:
        signals:
          description: A list of signals for the gateway.
          type: array
          items:
            $ref: "#/components/schemas/EventGatewaySignal"
      required:
        - signals
```
