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.

Body

integer · int64[]optional

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'youragentURL.symphony.com/agent/v1/signals/{id}/subscribe' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '[
    1
  ]'

200

400

401

403

500

200

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

Signal subscribed.

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.