Skip to content

Commit dce5445

Browse files
committed
updated README
1 parent a6dfe1a commit dce5445

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.github/templates/README.template.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,31 @@ environment:
171171
DEFAULT_RECIPIENTS: ' [ "user.id", "000", "001", "group.id" ] '
172172
```
173173

174+
#### Message Aliases
175+
176+
To improve compatibility with other services Secured Signal API provides aliases for the `message` attribute by default:
177+
178+
| Alias | Priority |
179+
| ----------- | ----------- |
180+
| msg | 100 |
181+
| content | 99 |
182+
| description | 98 |
183+
| text | 20 |
184+
| body | 15 |
185+
| summary | 10 |
186+
| details | 9 |
187+
| payload | 2 |
188+
| data | 1 |
189+
190+
Secured Signal API will use the highest priority Message Alias to get the correct message from the Request Body.
191+
192+
If you are missing a Message Alias to have Secured Signal API integrated with a Service you can simply set `MESSAGE_ALIASES` in ENV:
193+
194+
```yaml
195+
environment:
196+
MESSAGE_ALIASES: ' [{ "alias": "note", "priority": 4 }, { "alias": "test", "priority": 3 }] '
197+
```
198+
174199
## Contributing
175200

176201
Found a bug? Want to change or add something?

0 commit comments

Comments
 (0)