Create Signal

Creates a new Signal.

Create a signal.

post
Header parameters
sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringOptional

Key Manager authentication token.

Body
namestringOptional

Signal name

querystringOptional

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.

visibleOnProfilebooleanOptional

Whether the signal is visible on its creator's profile

companyWidebooleanOptional

Whether the signal is a push signal

Responses
200

Signal created.

application/json
Responseall of
post
POST /agent/v1/signals/create HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "name": "text",
  "query": "text",
  "visibleOnProfile": true,
  "companyWide": true
}
{
  "name": "text",
  "query": "text",
  "visibleOnProfile": true,
  "companyWide": true,
  "id": "text",
  "timestamp": 1
}

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.

Last updated

Was this helpful?