1.0
OAS 3.1.0

API Settings

Basic Authentication (sec0)
Client Libraries
Shell
Ruby
Node.js
PHP
Python
More

/events

Send in a lead or an event related to a lead.

Body
application/json
source
string

The name of the lead source.

system
string

The name of the system used in providing leads.

type
string

The type of event. Currently one of Registration, Inquiry, Seller Inquiry, Property Inquiry, General Inquiry, Viewed Property, Saved Property, Visited Website, Incoming Call, Unsubscribed, Property Search, Saved Property Search, Visited Open House or Viewed Page.

message
string

A message from the user about this inquiry.

description
string

Any additional information about this inquiry.

person
object

Information about the lead who triggered this event. Rollout will automatically de-duplicate people based on their phone number or email address.

property
object

Information about the property this event is related to.

propertySearch
object

If this event was an inquiry you may have information about what the person was searching for, you can submit this information using this field.

campaign
object

The name of the source where the lead originated. (e.g., If the lead came to your site through an organic search on www.google.com the source is "Google".)

pageTitle
string

This field is to be used with the Viewed Page event type and indicates the title of the page viewed. (e.g., "Contact Us")

pageUrl
string

This field is to be used with the Viewed Page event type and indicates the url of the page viewed. (e.g., "http://www.samplerealestate.com/contact-us")

pageReferrer
string

This field is to be used with the Viewed Page event type and indicates the referrer url where the visitor came from. (e.g., "https://www.google.com") (Note: If pageReferrer is sent in, pageUrl should be set as well.)

pageDuration
integer int32

This field is to be used with the Viewed Page event type and indicates the duration of the visitor on the page viewed given in seconds.

occurredAt
string date

The date this event occurred. This is used to determine if the event is historical. Historical events will not trigger workflows upon creation. Any DateTime greater than 1 day will be considered historical.

Responses
  • 200200
    application/json
  • 201201
    text/plain
  • 204204
    text/plain
  • 404404
    application/json
POST/events
Shell cURL
curl --request POST \
  --url https://your_project_env_key.rolloutapp.com/v1/events \
  --data '{
  "source": "Zillow",
  "system": "Zillow",
  "type": "Property Inquiry",
  "message": "I am interested in 6825 Mulholland Dr, ...",
  "description": "Move-in: 12/28/2013",
  "person": {
    "id": 1234,
    "firstName": "Melissa ",
    "lastName": "Hartman",
    "emails": [
      {
        "value": "m.hartman@example.com",
        "type": "home"
      }
    ],
    "phones": [
      {
        "value": "(555) 555-1234",
        "type": "home"
      }
    ],
    "tags": [
      "Lease option"
    ],
    "sourceUrl": "http://click.email.zillow.com/?qs=1e120cec11e3",
    "customBirthday": "2/16/1990"
  },
  "property": {
    "street": "6825 Mulholland Dr",
    "city": "Los Angeles",
    "state": "CA",
    "code": "90068",
    "mlsNumber": "14729339",
    "price": "310000",
    "forRent": "0",
    "url": "http://www.zillow.com/homedetails/6825-Mulholland-Dr-Los-Angeles-CA-90068/2109065822_zpid/",
    "type": "Residential"
  },
  "propertySearch": {
    "type": "Lot",
    "neighborhood": "Cahuenga Pass",
    "city": "Los Angeles",
    "state": "CA",
    "code": "90068",
    "minPrice": 100000,
    "maxPrice": 500000
  },
  "campaign": {
    "source": "google",
    "medium": "organic",
    "term": "Cahuenga Pass land",
    "content": "",
    "campaign": ""
  }
}'
{
  "value": "{}"
}