create_event
Register a new lead or record a lead event in Follow Up Boss to trigger lead routing, automations, and per-source workflows.
Instructions
Send in a lead or an event related to a lead. (POST /events) Use this — not create_person — when a NEW LEAD needs to be registered and should trigger FUB's lead routing, automations, and per-source workflows. create_person only inserts a bare contact record and triggers none of that; this is the actual lead-ingestion event. Set type to 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 — Registration for a genuinely new lead. Set source (and system if relevant) since lead routing rules commonly key off source. FUB auto-deduplicates the nested person object by phone/email — no separate deduplicate flag needed here, unlike create_person. ⚠️ If occurredAt is set to more than 1 day in the past, FUB treats the event as historical and will NOT trigger routing/automations at all — leave it unset (defaults to now) or within the last day if the point is to actually trigger workflows; only backdate it deliberately for importing historical data where you specifically don't want anything to fire.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | 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`. | |
| person | No | Information about the lead who triggered this event. Follow Up Boss will automatically de-duplicate people based on their phone number or email address. | |
| source | No | The name of the lead source. | |
| system | No | The name of the system used in providing leads. | |
| message | No | A message from the user about this inquiry. | |
| pageUrl | No | 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") | |
| campaign | No | 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".) | |
| property | No | Information about the property this event is related to. | |
| extraBody | No | Extra raw JSON body fields not explicitly listed above — e.g. custom.* fields when creating/updating people or deals. Keys and values are sent as-is. | |
| pageTitle | No | This field is to be used with the `Viewed Page` event type and indicates the title of the page viewed. (e.g., "Contact Us") | |
| extraQuery | No | Extra raw query parameters not explicitly listed above — e.g. FUB custom field filters like custom.ClosingDate on /people or /deals. Keys and values are sent as-is. | |
| occurredAt | No | 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. | |
| description | No | Any additional information about this inquiry. | |
| pageDuration | No | 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. | |
| pageReferrer | No | 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.) | |
| propertySearch | No | 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. |