Subscribe Signal

Subscribe an array of users to a Signal. To subscribe an entire pod to a Signal, set the companyWide field in Create Signal.

Subscribe to a Signal.

post

Path parameters

idstringRequired

The id of the signal.

Query parameters

pushedbooleanOptional

Prevent the user to unsubscribe (only for bulk subscription)

Header parameters

sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringOptional

Key Manager authentication token.

Bodyinteger · int64[]

integer · int64[]Optional

Responses

200

Signal subscribed.

application/json

requestedSubscriptioninteger · int64Optional

The number of requested userIds to subscribe

successfulSubscriptioninteger · int64Optional

The number of successful subscriptions done

failedSubscriptioninteger · int64Optional

The number of subscription failures

400

Client error, see response body for further details.

application/json

401

Unauthorized: Session tokens invalid.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post/v1/signals/{id}/subscribe

POST /agent/v1/signals/{id}/subscribe HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

{
  "requestedSubscription": 1,
  "successfulSubscription": 1,
  "failedSubscription": 1,
  "subscriptionErrors": [
    {
      "userId": 1,
      "code": "text",
      "message": "text"
    }
  ]
}

Request Examples

curl -X POST \
https://acme.symphony.com/agent/v1/signals/5a6efc9db9d8210001b9960b/subscribe \
  -H 'content-type: application/json' \
  -H 'sessiontoken: SESSION_TOKEN' \
  -H 'keymanagertoken: KEYMANAGER_TOKEN' \   
  -d '[68719476759, 68719476760, 68719476761]'

curl -X POST
  -H 'content-type: application/json'
  -H 'sessiontoken: SESSION_TOKEN'
  -H 'keymanagertoken: KEYMANAGER_TOKEN'  
  https://acme.symphony.com/agent/v1/signals/5a6efc9db9d8210001b9960b/subscribe

🚧 Required Permissions

To subscribe other users to a specific signal, the requesting user needs to have the canManageSignalSubscription entitlement.