Create Signal

Creates a new Signal.

Create a signal.

POSTyouragentURL.symphony.com/agent/v1/signals/create

Header parameters

Body

application/json

Signal definition.

namestring

Signal name

querystring

The query used to define this signal. The query is defined as "field:value" pairs combined by the operators "AND" or "OR". Supported fields are (case-insensitive): "author", "hashtag" and "cashtag". MUST contain at least one "hashtag" or "cashtag" definition.

visibleOnProfileboolean

Whether the signal is visible on its creator's profile

companyWideboolean

Whether the signal is a push signal

Response

200400401403451500

Signal created.

Body

application/json

namestring

Signal name

querystring

The query used to define this signal. The query is defined as "field:value" pairs combined by the operators "AND" or "OR". Supported fields are (case-insensitive): "author", "hashtag" and "cashtag". MUST contain at least one "hashtag" or "cashtag" definition.

visibleOnProfileboolean

Whether the signal is visible on its creator's profile

companyWideboolean

Whether the signal is a push signal

idstring

Signal ID

timestampinteger (int64)

Timestamp when the signal was created, in milliseconds since Jan 1 1970

companyWideboolean

Whether the signal is a push signal

Request

JavaScriptCurlPython

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

Response

200400401403451500

{
  "name": "text",
  "query": "text",
  "visibleOnProfile": false,
  "companyWide": false,
  "id": "text"
}

Request Example

curl -X POST \  
  https://acme.symphony.com/agent/v1/signals/create \
  -H 'content-type: application/json' \
  -H 'keymanagertoken: KEYMANAGER_TOKEN' \
  -H 'sessiontoken: SESSION_TOKEN' \
  -d '{
	  "name": "hash and cash",
	  "query": "HASHTAG:hash AND CASHTAG:cash",
	  "visibleOnProfile": true,
    "companyWide": false
  }'

🚧 Known Limitations

• DLP only works with 1.53 version and onwards.

• To create a company-wide signal, the requesting user needs to have the canCreatePushedSignals entitlement.

• To send numeric cashtags as signals, add a * before the number, for example, $*122450.