Custom events in the prospect activity feed

If you are aware of interesting events happening to Outreach prospects you can send custom events to indicate these changes inside prospect activity feed.

Configuring extension

Add the "Activity feed custom events" feature to your app, then configure one or more custom events.

The event name and template will be displayed in the activity feed. In the payload you can additionally send accompanying text that will also appear in the event card (see below).

Sending events

Once you have configured your event extension, call the events endpoint with S2S token:

curl https://api.outreach.io/api/v2/events \
  -X POST \
  -H "Authorization: Bearer S2S_TOKEN" \
  -d DATA

DATA is the event data in JSON format as below:

{
  "data": {
    "type": "event",
    "attributes": {
      "name": "my-app:my-event",
      "externalUrl": "https://my-app.com/messages/123",
      "body": "Hey there, this text will appear in the event card."
    },
    "relationships": {
      "prospect": {
        "data": {
          "type": "prospect",
          "id": "PROSPECT_ID"
        }
      }
    }
  }
}

The fields in the payload have the following meaning:

• name - corresponds to the configured event id (in a form of <app identifier>:<event id> ).
• externalUrl - the target URL of the event card
• body - a text string to appear in the card.
• PROSPECT_ID - Outreach prospect id that this event should be associated with.

The event card will also contain the template string you have configured for the event. In the template string you can use the {{prospect}} placeholder which Outreach will replace with a link to the prospect.