Create a Signal

POST 
/v2/signals

Deliver a Signal to Salesloft. Signals must follow the structure defined on the Signal Registration.

For additional information on sending Signals, visit the signals details page.

Request

application/json

Body

required

urgency stringrequired

A way for the partner to define the urgency level. Accepted values are: high, medium, and low.

type stringrequired

Signal type

occurred_at date-timerequired

The ISO 8601 timestamp of when the signal happened on the partner's system.

indicators object[]required
Array of signal events that happened during the session.
Example:
[
  {
     "key": "shared",
     "metadata":{
       "share_count": 8
     }
   }
 ]
Array [
]
idempotency_key stringrequired

A UUID4 that uniquely identifies the signal in the partner system. If we receive two signals with the same idempotency_key one of them will be dropped. The first one wins.

data objectrequired
The object containing the context metadata that could be shown to the end user.
Example:
{
  "video_url": "https://salesloft_video.com/some-video",
  "video_date": "2018-11-13"
}
broadcast_notification boolean

Determines if the signal will display in the user's live feed. Defaults to true.

attribution objectrequired
The object containing Salesloft object IDs that were defined on signal_type registration. These ids can be retrieved using Salesloft API or integration context.
Example:
{
  "person_id": 12,
  "account_id": 22
}

Responses

200

Success

application/json

Schema

Schema

urgency string

Urgency level. Accepted values are: high, medium, and low.

type string

Signal type.

registration object

Registration linked to signal.

received_at date-time

ISO 8601 timestamp of when the signal was received by Salesloft.

occurred_at date-time

ISO 8601 timestamp of when the signal occurred on the partner’s system.

integration object

Integration linked to signal.

indicators object[]
Array of signal indicators that happened during the signal.
Array [
]
idempotency_key string

A UUID4 that uniquely identifies the signal in the partner system.

description object

Object containing the localized signal description.

data object

Object containing the context metadata that could be shown to the end user. It follows the structure defined on registration.

broadcast_notification boolean

Determines if the signal will display in the user's live feed.

attribution object

Object containing Salesloft object IDs that were defined on signal_type registration.

Example (from schema)

{
  "urgency": "high",
  "type": "video_watched",
  "registration": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/integrations/signals/registrations/1/"
  },
  "received_at": "2019-01-01T00:00:00.000Z",
  "occurred_at": "2019-01-01T00:00:00.000Z",
  "integration": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/integrations/1/"
  },
  "indicators": [
    {
      "metadata": {
        "signal_happened_at": "2023-10-10T07:05:12Z",
        "recipient_count": 1
      },
      "key": "pitch_shared_to_at_least_1_person",
      "description": {
        "en-us": "Pitch was shared at Oct 10, 2023, 7:05:12 AM with recipients[0]"
      }
    }
  ],
  "idempotency_key": "37014a7a-5c8f-44a0-84b3-352394d28814",
  "description": {
    "en-us": "Pitch was shared at Oct 10, 2023, 7:05:12 AM with 100 multiple recipients"
  },
  "data": {
    "shared_at": "2023-10-10T07:05:12Z",
    "recipient_count": 100,
    "pitch_url": "https://example.com"
  },
  "broadcast_notification": true,
  "attribution": {
    "person_id": 1
  }
}

Loading...