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 our 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.

Collector > Collecting events via websocket

A comprehensive guide to real-time data collection methods showcasing REST API websocket and CLI agent integrations for manufacturing monitoring through secure authentication channels and IoT device connections.

Websocket > Send events via the web socket

Websocket connections enable real-time event transmission by sending messages with event type and attributes while receiving status confirmations through an established channel.

Agent > Authentication for the agent collector

The configuration file requires an organization ID project ID and project key values for authentication with the Manufactory system while ensuring both files are in the same directory.
Get in touch
About Tallyfy