Notification Controller

post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
sessionIdstringRequired
Query parameters
notificationTypestringRequired
Responses
post
/api/notifications/{sessionId}/unsubscribe
POST /api/notifications/{sessionId}/unsubscribe?notificationType=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
sessionIdstringRequired
Responses
200

OK

No content

post
/api/notifications/{sessionId}/unregister
POST /api/notifications/{sessionId}/unregister HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
sessionIdstringRequired
Query parameters
notificationTypestringRequired
Responses
post
/api/notifications/{sessionId}/subscribe
POST /api/notifications/{sessionId}/subscribe?notificationType=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
sessionIdstringRequired
Query parameters
notificationTypesstring[]Optional
Responses
200

OK

text/event-stream
get
/api/notifications/{sessionId}/register
GET /api/notifications/{sessionId}/register HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
{
  "timeout": 1
}

Last updated