Skip to main content
Last updated on May 28, 2026

Config Service Events 0.1.0 documentation

Published Messages (commonConfiguration)

The service publishes one of these messages below.

commonConfigurationCreated

This message is sent when common configuration is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"isPublic": true
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
namespacestringNamespace of the config
keystringKey of the config
valuestringValue of the config
isPublicbooleanFlag to indicates whether the config visible for public users

commonConfigurationUpdated

This message is sent when common configuration is updated. Contains fields from event and the following payload.

Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"previousValue": "string",
"isPublic": true
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
namespacestringNamespace of the config
keystringKey of the config
valuestringNew value of the config after the update
previousValuestringValue of the config before the update
isPublicbooleanFlag to indicates whether the config visible for public users

commonConfigurationDeleted

This message is sent when common configuration is deleted. Contains fields from event and the following payload.

Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"isPublic": true
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
namespacestringNamespace of the config
keystringKey of the config
valuestringValue of the config at the time of deletion
isPublicbooleanFlag to indicates whether the config visible for public users

Published Messages (restrictedConfiguration)

The service publishes one of these messages below.

restrictedConfigurationCreated

This message is sent when restricted configuration is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"category": "INTERNAL"
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
namespacestringNamespace of the config
keystringKey of the config
valuestringValue of the config
categorystringIntended usage category of the config

restrictedConfigurationUpdated

This message is sent when restricted configuration is updated. Contains fields from event and the following payload.

Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"previousValue": "string",
"category": "INTERNAL"
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
namespacestringNamespace of the config
keystringKey of the config
valuestringNew value of the config after the update
previousValuestringValue of the config before the update
categorystringIntended usage category of the config

restrictedConfigurationDeleted

This message is sent when restricted configuration is deleted. Contains fields from event and the following payload.

Example value
{
"payload": {
"namespace": "string",
"key": "string",
"value": "string",
"category": "INTERNAL"
},
"id": "string",
"version": 0,
"name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"namespace": "string",
"clientId": "string",
"userId": "string",
"parentNamespace": "string",
"unionNamespace": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
namespacestringNamespace of the config
keystringKey of the config
valuestringValue of the config at the time of deletion
categorystringIntended usage category of the config

Schemas

event

NameTypeDescription
idstringUnique ID for this event instance
versionintegerEvent schema version (e.g. 1 or 2) - distinguishes payload structure revisions for the same event name
namestringEvent name - identifies what happened
timestampstring (date-time)Timestamp when the event was published
namespacestringThe namespace of the resource.
clientIdstringThe OAuth2 clientId that issued the access token of the actor
userIdstringThe actor's userId, empty if the action is triggered using client credentials
parentNamespacestringThe actor's publisher/studio namespace that triggers the action. Old field version, refer to 'unionNamespace' for newer one.
unionNamespacestringThe actor's publisher/studio namespace that triggers the action
traceIdstringDistributed trace ID for correlating logs/spans across services
sessionIdstring-