Websocket > Connect to our web socket server
Authentication for a websocket connection requires pairing with client/end-user through an auth message containing org ID project ID actor profile ID and client UUID before enabling event transmission.
Before you can start sending data to Manufactory via a web socket, you need to authenticate the client/end-user.
You can authenticate users using the endpoint POST /auth
.
Required header:
X-Manufactory-Auth
- Project key of the project to be populated.org_id
(required) string - Manufactory org ID.project_id
(required) number - The project ID associated with this schema.actor_profile
(required) object - Pairs containing attribute name and the corresponding value while considering the correct attribute names and data types. Please refer to Get Actors schema.{ "org_id": "xyz", "project_id": 12345, "actor_profile":{ "city": "New York", "country": "USA", "username": "john.doe", "email": "john.doe@email.com"
}}
{ "org_id": "xyz", "project_id": 12345, "actor_profile_id": 1, "client_uuid": "dcd21714-894c-46bc-9d59-ae9f22753205"}
The generated client UUID is limited to this specific user profile, and it’s valid for a 12 hours session. After 12 hours, you would need to re-authenticate the client.
Websocket > Connect to our web socket server
Collector > Collecting events via websocket
Agent > Authentication for the agent collector