matrix/uk.half-shot.matrix-hookshot.feed/README.md: check how hookshot configures state

This commit is contained in:
Aminda Suomalainen 2023-03-25 18:19:50 +02:00
parent 94d39ef652
commit e8070be201
Signed by: Mikaela
SSH Key Fingerprint: SHA256:CXLULpqNBdUKB6E6fLA1b/4SzG0HvKD19PbIePU175Q

View File

@ -0,0 +1,46 @@
# hookshot room state configuration
When Hookshot is configured via the manage integrations menu, it appears to
perform two state installations/directories/whatever:
- `uk.half-shot.matrix-hookshot.feed`
- contains state events with the feed name
- contains the json below
- `io.element.integrations.installations`
- contains uuid below
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [feed](#feed)
- [installation](#installation)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
--
## feed
This entry is the feed url e.g.
`https://feeds.yle.fi/uutiset/v1/recent.rss?publisherIds=YLE_NEWS`, and
contains:
```json
{
"label": "YLE News in English",
"url": "https://feeds.yle.fi/uutiset/v1/recent.rss?publisherIds=YLE_NEWS"
}
```
## installation
This probably has or should be left for the integration manager.
```json
{
"appId": "hookshot-feeds",
"installationId": "uuid-goes-here",
"userIds": ["@feeds:integrations.ems.host"],
"widgetIds": []
}
```