Skip to content

Connect to our web socket server

After successful authentication and getting client UUID along with actor profile ID, you can connect to the Tallyfy Manufactory websocket server: wss://collector.tallyfy.com/ws

Once a websocket connection is established you will receive a message Manufactory Collector ✅

The next step is that we need to pair the connection with the client/end-user. This is where actor profile ID and client UUID become active.

Required keys

  • type (required) string - The message type, in this case we will be using auth.
  • org_id (required) string - Manufactory org ID.
  • project_id (required) number - The project ID associated with this schema.
  • actor_profile_id (required) number - The actor profile ID we got after authentication.
  • client_uuid (required) string - the generated UUID we got after authentication.

Websocket message example

{
"type": "auth",
"org_id": "xyz",
"project_id": 12345,
"client_uuid": "e17a56a9-596f-40e6-b01c-d37136df1de8",
"actor_profile_id": 1
}

Websocket reply example

{
"type": "auth",
"status": "ok"
}

Now we are able to send actor’s generated events via the open websocket channel.

Websocket > Send events via the web socket

Websocket events can be sent to Tallyfy Manufactory using a JSON message containing a type field set to “event” and an attributes object with the event data which returns a confirmation message upon successful processing.

Manufactory > Collector

The Tallyfy Manufactory collector enables sending actor data and events through REST API websocket or CLI agent methods with data viewable in a custom interface after creating required schemas.