Skip to content

Commit d439a1c

Browse files
Update README.md
1 parent bc9e03a commit d439a1c

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,31 @@ environment:
232232
DEFAULT_RECIPIENTS: ' [ "user.id", "000", "001", "group.id" ] '
233233
```
234234
235+
#### Message Aliases
236+
237+
To improve compatibility with other services Secured Signal API provides aliases for the `message` attribute by default:
238+
239+
| Alias | Priority |
240+
| ----------- | ----------- |
241+
| msg | 100 |
242+
| content | 99 |
243+
| description | 98 |
244+
| text | 20 |
245+
| body | 15 |
246+
| summary | 10 |
247+
| details | 9 |
248+
| payload | 2 |
249+
| data | 1 |
250+
251+
Secured Signal API will use the highest priority Message Alias to get the correct message from the Request Body.
252+
253+
If you are missing a Message Alias to have Secured Signal API integrated with a Service you can simply set `MESSAGE_ALIASES` in ENV:
254+
255+
```yaml
256+
environment:
257+
MESSAGE_ALIASES: ' [{ "alias": "note", "priority": 4 }, { "alias": "test", "priority": 3 }] '
258+
```
259+
235260
## Contributing
236261

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

0 commit comments

Comments
 (0)