Meta Experimental

WARNING

This is an experimental feature and may change in future versions.

The meta object contains information related to the SDK's state that is not specific to any particular login, such as proxy routes.

Meta information is obtained and updated through the following mechanisms:

• With WebSocket event delivery, the READY signal provides the complete meta information;
• With WebHook event delivery, the application should obtain meta information via the API on startup;
• After startup, the application continuously receives META signals and login events to update the meta information.

Note that the META signal does not reflect login state changes and will not include the logins field.

The meta API is served at /{version}/meta/{method}. Communication is similar to the HTTP API, but does not require the Satori-Platform or Satori-User-ID headers.

Definitions

Meta

FIELD	TYPE	DESCRIPTION
logins	Login[]	login information
proxy_urls	string[]	list of proxy routes

API

Get Meta

POST/meta

Returns a Meta object.

Create WebHook Optional

POST/meta/webhook.create

FIELD	TYPE	DESCRIPTION
url	string	WebHook URL
token	string?	authentication token

Delete WebHook Optional

POST/meta/webhook.delete

FIELD	TYPE	DESCRIPTION
url	string	WebHook URL