Skip to content

Commit 5362c5c

Browse files
JsyroCopilotjamshale
authored
Update AdminAPI.md (#3936)
* Update AdminAPI.md Signed-off-by: Jason Syrotuck <jasyrotuck@gmail.com> * Update AdminAPI.md Signed-off-by: Jason Syrotuck <jasyrotuck@gmail.com> * Update docs/features/AdminAPI.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Jason Syrotuck <jasyrotuck@gmail.com> * Update docs/features/AdminAPI.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Jason Syrotuck <jasyrotuck@gmail.com> --------- Signed-off-by: Jason Syrotuck <jasyrotuck@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: jamshale <31809382+jamshale@users.noreply.github.com>
1 parent 0f94ef5 commit 5362c5c

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

docs/features/AdminAPI.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,12 @@ Webhooks received over WebSocket will contain the same data as webhooks posted o
3939
* `payload`: The payload of the webhook; this is the data usually received in the request body when webhooks are delivered over HTTP
4040
* `wallet_id`: If using multitenancy, this is the wallet ID of the subwallet that emitted the webhook. This value will be omitted if not using multitenancy.
4141

42-
To open a WebSocket, connect to the `/ws` endpoint of the Admin API.
42+
To open a WebSocket, connect to the `/ws` endpoint of the Admin API. E.g. If the Admin Swagger can be found at `http://localhost:3001`, the webhook websocket is at `ws://localhost:3001/ws`.
43+
44+
Websocket connection will also require two additional headers:
45+
* `Authorization`: a JWT token prepended with `Bearer `
46+
* `X-API-key`: the admin API key value set via the --admin-api-key configuration parameter.
47+
4348

4449
### Pairwise Connection Record Updated (`/connections`)
4550

0 commit comments

Comments
 (0)