Skip to content

Commit 48b8f36

Browse files
committed
JE-61312 [Add API to send messages from containers with IP authorization] - add onCustomNodeEvent to CS docs
1 parent eaee3a5 commit 48b8f36

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

docs/creating-manifest/events.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2035,6 +2035,59 @@ This event provides a possibility to execute actions required to adjust a subscr
20352035
- `${event.response.}`:
20362036
- `result` - result code. The successful action result is '0'
20372037

2038+
### onCustomNodeEvent
2039+
This event is executed when the **environment > Node > SendEvent** API method is called with the `eventName=CUSTOM_NODE_EVENT` parameter.
2040+
2041+
**Event Placeholders:**
2042+
2043+
- `${event.params.}`:
2044+
- `NODE_NAME` - target container name
2045+
- `NODE_GROUP` - unique identifier of the target node group (layer), e.g. "cp" for the default application server layer
2046+
- `ENV_INFO` - environment iformation
2047+
- `name` - name of the event (for filtering)
2048+
- `ENV_NAME` - target environment name
2049+
- `NODE_ID` - unique identifier if the target node
2050+
- `USER_NAME` - target user name (email)
2051+
- `envName` - target environment name
2052+
- `nodeId` - unique identifier if the target node
2053+
- `${event.response.}`:
2054+
- `result` - result code. The successful action result is '0'
2055+
2056+
Events Subscription Example:
2057+
2058+
@@@
2059+
```yaml
2060+
type: update
2061+
name: Test Custom Node Events
2062+
targetNodes: any
2063+
2064+
onCustomNodeEvent [name:test]:
2065+
log: "filter by custom parameter. Event: ${event}"
2066+
2067+
onCustomNodeEvent [${targetNodes.nodeGroup}]:
2068+
log: "filter by nodeGroup. Event: ${event}"
2069+
```
2070+
```json
2071+
{
2072+
"type": "update",
2073+
"name": "Test Custom Node Events",
2074+
"targetNodes": "any",
2075+
"onCustomNodeEvent [name:test]": {
2076+
"log": "filter by custom parameter. Event: ${event}"
2077+
},
2078+
"onCustomNodeEvent [${targetNodes.nodeGroup}]": {
2079+
"log": "filter by nodeGroup. Event: ${event}"
2080+
}
2081+
}
2082+
```
2083+
@@!
2084+
2085+
Triggering:
2086+
2087+
```
2088+
jem api apicall [PLATFORM_DOMAIN]/1.0/environment/node/rest/sendevent --data-urlencode params={"name":"test1"}
2089+
```
2090+
20382091
<br>
20392092

20402093
<h2>What’s next?</h2>

0 commit comments

Comments
 (0)