Files
upstream-espocrm/schema/metadata/app/webSocket.json
upstream-mirror 7cc7e6b4f3
Some checks failed
Test / Test on PHP 8.3 (push) Failing after 5s
Test / Test on PHP 8.4 (push) Failing after 4s
Test / Test on PHP 8.5 (push) Failing after 3s
TypeScript static analysis / TypeScript check (push) Failing after 14s
Test Integration on MySQL / Test on PHP 8.3 (push) Failing after 1s
Test Integration on MySQL / Test on PHP 8.5 (push) Failing after 1s
Test Integration on PostgreSQL / Test on PHP 8.4 fix (push) Failing after 1s
Test Integration on PostgreSQL / Test on PHP 8.4 master (push) Failing after 1s
snapshot of https://github.com/espocrm/espocrm.git (master, 2026-09-18; blobs > 131072B omitted)
2026-09-18 04:19:15 +05:00

45 lines
2.1 KiB
JSON

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://www.espocrm.com/schema/metadata/app/webSocket.json",
"title": "app/webSocket",
"description": "WebSocket definitions.",
"type": "object",
"properties": {
"categories": {
"type": "object",
"description": "Categories. Define custom WebSocket events here. You can use dots in category names. Must start with a lower case letter.",
"additionalProperties": {
"type": "object",
"description": "A category.",
"properties": {
"paramList": {
"type": "array",
"items": {"type": "string"},
"description": "Parameters passed within a topic. E.g. the topic name myGroupName.myCustomName.Account.someId. This makes a topic name unique for a specific record. For global events, omit this parameter."
},
"accessCheckCommand": {
"type": "string",
"description": "A console command that will be used to check whether a topic is allowed for a user when they attempting to subscribe. Parameter placeholders starts with the colon :. The userId parameter contains a user ID. If access checking is not needed, omit this parameter."
}
}
}
},
"messagers": {
"type": "object",
"description": "Provides the ability to implement other messagers rather than the default ZeroMQ. E.g. RabbitMQ.",
"additionalProperties": {
"type": "object",
"description": "A messager.",
"properties": {
"senderClassName": {
"description": "A sender. Should implement Espo\\Core\\WebSocket\\Sender."
},
"subscriberClassName": {
"description": "A subscriber. Should implement Espo\\Core\\WebSocket\\Subscriber."
}
}
}
}
}
}