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.

POSTyouragentURL.symphony.com/agent/v1/signals/{id}/subscribe

Path parameters

id*string

The id of the signal.

Query parameters

Header parameters

Body

application/json

UserIds to subscribe (only for bulk subscription)

itemsinteger (int64)

Response

200400401403500

Signal subscribed.

Body

application/json

requestedSubscriptioninteger (int64)

The number of requested userIds to subscribe

successfulSubscriptioninteger (int64)

The number of successful subscriptions done

failedSubscriptioninteger (int64)

The number of subscription failures

subscriptionErrorsarray of ChannelSubscriptionError (object)

Request

JavaScriptCurlPython

const response = await fetch('youragentURL.symphony.com/agent/v1/signals/{id}/subscribe', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([]),
});
const data = await response.json();

Response

200400401403500

{
  "subscriptionErrors": [
    {
      "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.