Seeq

​

Overview

​

Prerequisites

1. A Seeq server the broker host can reach. Seeq SaaS sites look like https://<company>.seeq.site. An on-premises server listens on http://<host>:34216 by default, or on HTTPS behind 443 / 8443.
2. A Seeq access key and its password (profile menu → Access Keys). Access keys work with every directory, including OAuth 2.0 / OpenID Connect single sign-on. Access key creation is off by default for non-admin users (Authentication/AccessKey/Creation/Enabled). An admin can turn it on or create the key for you. A Seeq directory user name and password also work.
3. Write access to the signals and conditions you push to. A signal or condition created through this connector belongs to the access key’s user and has global scope unless you set scopedTo to a workbook ID.

​

Authentication

1. Log in: publish { "body": { "username": "<access key>", "password": "<access key password>" } } to historian/seeq/session/create. Leave authProviderClass and authProviderId out to use the Seeq directory, which access keys require. For a directory user (for example LDAP), set both to the directory’s datasource class and ID from GET /api/auth/providers.
2. Seeq returns the token in the x-sq-auth response header. The response body (historian/seeq/session/create/response) is the user record, not the token. The connector publishes the body, so get the token another way, for example with a one-off call from the broker host, and store it as a Hub secret:

curl -s -D - -o /dev/null -X POST https://<server>/api/auth/login \
  -H "Accept: application/vnd.seeq.v1+json" -H "Content-Type: application/vnd.seeq.v1+json" \
  -d '{"username":"<access key>","password":"<access key password>"}' | grep -i '^x-sq-auth'

3. Send "auth": "<token>" with every other event. The connector puts it in the x-sq-auth header.
4. Seeq ends a session after a period of inactivity (the user’s sessionDuration). A Ping every few minutes keeps it alive. A 401 on any response means the token has expired: log in again. Access keys also stop working when their user has not logged in to Seeq within Authentication/AccessKey/ValidityWithoutUserLogin (14 days by default).

​

Configuration

• Replace YOUR_SEEQ_SERVER in BASE_ADDRESS with your Seeq host. For an on-premises server without TLS use http://<host>:34216 and set USE_SSL to "false".
• Every request sends Accept: application/vnd.seeq.v1+json, and every body uses Content-Type: application/vnd.seeq.v1+json. Seeq rejects other values: 406 for a different Accept, 415 for plain application/json. Keep these headers if you add your own events.
• Keys (timestamps) are ISO 8601, for example 2026-10-05T07:00:00Z. Use Z. A +hh:mm offset in a query string must be URL-encoded (%2B).
• Signal, condition and item IDs are Seeq GUIDs. CreateSignal and CreateCondition return them in id. You can also find them with SearchItems (filters=Name==Line1 Temperature&types=StoredSignal) or copy them from Workbench (Item Properties).
• GetSamples and GetCapsules return at most limit entries. When more exist, the response carries a continuationToken.
• Errors are JSON { "statusMessage": "..." }. 403 means the user lacks write access to the item, and 404 means the ID is unknown or archived.
• Seeq SaaS sits behind Cloudflare. Requests with the default Python urllib User-Agent are refused with Cloudflare error 1010. Requests with no User-Agent or a normal client User-Agent are accepted.

​

Examples

// publish to historian/seeq/signal/create
{ "auth": "<token>",
  "body": { "name": "Coreflux Line1 Temperature", "valueUnitOfMeasure": "degC",
            "interpolationMethod": "Linear", "maximumInterpolation": "1h" } }
// historian/seeq/signal/create/response (shortened)
{ "id": "0EF2C1F0-6E6B-7AF0-9C1A-2B3C4D5E6F70", "name": "Coreflux Line1 Temperature", "type": "StoredSignal", ... }

// publish to historian/seeq/sample/create
{ "auth": "<token>", "id": "<signal id>",
  "body": { "samples": [{ "key": "2026-10-05T07:00:00Z", "value": 21.4 }, { "key": "2026-10-05T07:00:10Z", "value": 21.5 }] } }

// publish to historian/seeq/sample/list
{ "auth": "<token>", "id": "<signal id>", "start": "2026-10-05T06:00:00Z", "end": "2026-10-05T07:00:00Z", "limit": 1000 }
// historian/seeq/sample/list/response
{ "samples": [{ "key": "2026-10-05T06:00:10Z", "value": 20.9 }, ...], "valueUnitOfMeasure": "degC", "limit": 1000 }

// publish to historian/seeq/capsule/create
{ "auth": "<token>", "id": "<condition id>",
  "body": { "capsules": [{ "start": "2026-10-05T06:40:00Z", "end": "2026-10-05T06:55:00Z",
                            "properties": [{ "name": "Alarm", "value": "HighTemp", "unitOfMeasure": "string" }] }] } }

// publish to historian/seeq/formula/run
{ "auth": "<token>",
  "body": { "formula": "$t.aggregate(average(), hours(), startKey())", "parameters": ["t=<signal id>"],
            "start": "2026-10-05T00:00:00Z", "end": "2026-10-05T07:00:00Z" } }

DEFINE ACTION SeeqKeepAlive
ON EVERY 5 MINUTES DO
    SET "auth" WITH GET SECRET "SEEQ_AUTH_TOKEN"
    PUBLISH TOPIC "historian/seeq/ping/get" WITH { "auth": {auth} }

DEFINE ACTION SeeqRememberSignalId
ON TOPIC "historian/seeq/signal/create/response" DO
    SET "id" WITH (GET JSON "id" IN PAYLOAD AS STRING)
    KEEP TOPIC "internal/seeq/signal-id/line1-temperature" WITH {id}

DEFINE ACTION SeeqRememberConditionId
ON TOPIC "historian/seeq/condition/create/response" DO
    SET "id" WITH (GET JSON "id" IN PAYLOAD AS STRING)
    KEEP TOPIC "internal/seeq/condition-id/line1-alarms" WITH {id}

DEFINE ACTION SeeqPushLine1Temperature
ON TOPIC "plant/line1/temperature" DO
    SET "auth" WITH GET SECRET "SEEQ_AUTH_TOKEN"
    SET "sid" WITH GET TOPIC "internal/seeq/signal-id/line1-temperature"
    SET "value" WITH PAYLOAD AS DOUBLE
    SET "ts" WITH TIMESTAMP "UTC"
    PUBLISH TOPIC "historian/seeq/sample/create" WITH { "auth": {auth}, "id": {sid}, "body": { "samples": [ { "key": {ts}, "value": {value} } ] } }

DEFINE ACTION SeeqStoreAlarmCapsule
ON TOPIC "plant/line1/alarm/closed" DO
    SET "auth" WITH GET SECRET "SEEQ_AUTH_TOKEN"
    SET "cid" WITH GET TOPIC "internal/seeq/condition-id/line1-alarms"
    SET "start" WITH (GET JSON "start" IN PAYLOAD AS STRING)
    SET "end" WITH (GET JSON "end" IN PAYLOAD AS STRING)
    SET "alarm" WITH (GET JSON "alarm" IN PAYLOAD AS STRING)
    PUBLISH TOPIC "historian/seeq/capsule/create" WITH { "auth": {auth}, "id": {cid}, "body": { "capsules": [ { "start": {start}, "end": {end}, "properties": [ { "name": "Alarm", "value": {alarm}, "unitOfMeasure": "string" } ] } ] } }

DEFINE ACTION SeeqPollLatestTemperature
ON EVERY 1 MINUTE DO
    SET "auth" WITH GET SECRET "SEEQ_AUTH_TOKEN"
    SET "sid" WITH GET TOPIC "internal/seeq/signal-id/line1-temperature"
    SET "now" WITH TIMESTAMP "UTC"
    PUBLISH TOPIC "historian/seeq/sample/get" WITH { "auth": {auth}, "id": {sid}, "key": {now}, "lookup": "AtOrBefore" }

​

Testing

​

Not covered

• Getting the session token inside the broker. Seeq returns it in the x-sq-auth response header, and the connector publishes only the response body (see Authentication).
• Workbooks, worksheets, Organizer topics and reports, assets and asset trees, signal / condition / scalar batch upserts, datasource-ID endpoints (/signals/{datasourceClass}/{datasourceId}/{dataId}) and calculated items. Use the same URL pattern and headers with your own event if you need them.
• Seeq Data Lab, SPy, Data Lab Functions, Add-ons and the Seeq Connector SDK.
• OData export (/odata.svc), which authenticates with the access key and its password directly.

​

Related

• REST API connectors
• REST API app catalog
• Seeq APIs and SDKs
• Working with Access Keys