Signal Object
The Signal object must be included in the body of the request. Signal objects can be subscribed and unsubscribed. The management of those subscriptions at both the individual and company-wide scales requires entitlements (see Entitlements below). The Signal object contains the following fields:
Field | Type | Description |
---|---|---|
name | String | Signal name |
query | String | The query used to define this signal and is composed of |
visibleOnProfile | Boolean | Specifies whether the signal is visible on its creator's profile. |
companyWide | Boolean | Specifies whether the signal is a company-wide signal. Users in the pod cannot unsubscribe. The Can create push signals entitlement is required to set this field. See Entitlements for more information. |
Entitlements
The following entitlements, which appear in the Admin Portal, provide you with subscription capabilities for both specified users and company-wide pods.
Entitlement | Capability |
---|---|
Can manage signal subscriptions | Allows you to subscribe specified users who cannot unsubscribe from a given signal. |
Can create push signals | Allows you to create company-wide signals that cannot be unsubscribed. |
Last updated