Webhooks Overview

Webhooks allow you to programmatically subscribe to certain events from Lead Voyager.

Webhooks allow you to programmatically subscribe to certain events from Lead Voyager. When one of these events is triggered, Lead Voyager will send an HTTP POST payload to the webhook’s URL.

Webhooks are configured at the Organization level. You can use the data in the webhook payload to determine the team, agent, or lead to which the event refers.

Subscribing to Webhooks

To subscribe to a webhook, you will need to give the URL for a website you control to your account manager. You can subscribe a single URL to multiple webhooks, or have individual URLs subscribed to each webhook you want to process.

Accepting Webhooks

Any URL you provide will begin receiving HTTP POSTs from Lead Voyager immediately. You should return a 200 OK HTTP response upon receipt. If Lead Voyager encounters any other return code, it will be logged as an error. Lead Voyager will not retry in case of error.

Payload Schema

Each webhook includes a payload in the form on a JSON object. The payload describes the data related to the event that triggered the webhook.

Base Properties

Each payload is a JSON object including several properties to help you understand the event that was triggered.

Field	Type	Required	Description
`lead`	lead	No	The associated lead
`eventName`	string	No	The name of the event that was triggered
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string (UUIDv4)	No	The unique ID of this message
`assignment`	assignment	No	The associated assignment

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "scrubber",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"acceptedDateTime": "2018-06-23T20:40:03.77967",
19		"assignedDateTime": "2018-06-23T20:34:28.861197"
20	},
21	"eventName": "leadAccepted",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

lead Property

The lead property is included in the payload for every webhook triggered from an event that deals with a lead, such as leadCreated or leadAssigned. It describes the basic information about the related lead. If you need more detail on a specific lead, you should access the lead through the Lead Voyager API.

Field	Type	Required	Description
`leadId`	number	No	The unique user ID of the lead in Lead Voyager
`userId`	string	No	The user ID from your system
`name`	string	No	The name of the lead
`email`	array of string	No	The known email addresses for this lead
`phone`	array of string	No	The known telephone numbers for this lead
`source`	string	No	The name of the lead source
`account`	string	No	The friendly name of the e-Team that received the lead
`teamEmail`	string	No	The Lead Voyager email address of the e-team that received this lead
`boostedAPIKey`	string (UUIDv4)	No	The Brytelytics API key of the lead source, if it arrived via Brytelytics
`aid`	string (UUIDv4)	No	The unique anonymous user ID created by Brytelytics (Brytelytics leads only)

1{
2	"lead": {
3		"userid": "2f1c32bf-2066-4acd-bc63-ee65566d9686",
4		"name": "Lead Name",
5		"email": ["leadEmail@hotmail.com"],
6		"phone": ["15551234567"],
7		"leadid": 1234,
8		"source": "your site",
9		"account": "your account",
10		"teamEmail": "youremail@bryteagent.com",
11		"boostedAPIKey": "your api key"
12	},
13	...
14}

assignment Property

Each payload related to an assignment or routing event, or events that occur on leads that are assigned to an agent, will have an assignment property describing which agent owns the lead. You should use this information to determine which agent's database is updated in your CRM.

Only one of two roles will be passed with this object: member or concierge.

member: a member of an e-Team, generally just a real estate agent.
concierge: a person who scrubs leads and can assign leads to agents, sometimes called an inside sales agent, or lead manager.

All members will have an additional field tag which describes their relationship with the lead on this deal. The tag field will always be null when the role is concierge.

Buyer: the member is the buyer's agent
Seller: the member is the listing agent
Renter: the member is the leasing agent
Scrubber: the tag is not yet determined (the lead is still being scrubbed by the member)

Field	Type	Required	Description
`role`	string	No	The role of the user
`tag`	string	No	The relationship of the member with this lead
`assignedTo`	string	No	The email address of the member assigned to this lead
`assignedDateTime`	timestamp (ISO 8601)	No	The date and time this assignment occurred
`assignedAgentId`	string	No	The user ID of the assigned member in your system (if your user roster is synced)

When a concierge is claiming a lead, these attributes may also be available in the assignment property.

Field	Type	Required	Description
`claimedBy`	string	No	The email address of the concierge who claimed this lead
`claimedDateTime`	timestamp (ISO 8601)	No	The date and time the concierge claimed the lead
`assignedConciergeId`	string	No	The user ID of the claiming concierge in your system (if your user roster is synced)

1{
2	"assignment": {
3		"tag": "scrubber",
4		"role": "member",
5		"assignedTo": "agent@example.com",
6		"acceptedDateTime": "2018-06-23T20:40:03.77967",
7		"assignedDateTime": "2018-06-23T20:34:28.861197"
8	},
9	...
10}

Assignment & Routing

Many events in Lead Voyager relate to assignment and routing of leads. You can subscribe to these events to update your system and keep your contacts in sync as Lead Voyager handles these tasks.

Agents do not get notified of assignments, and you should expect assignments to change before the agent ever sees a lead.

When a lead is routed to an agent, the agent will get notified of the lead availability, and must accept the lead before accessing it.

When an agent accepts a lead, you can safely add the lead to the agent's database in your system.

leadAccepted

A lead was accepted by the assigned real estate agent.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "scrubber",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"acceptedDateTime": "2018-06-23T20:40:03.77967",
19		"assignedDateTime": "2018-06-23T20:34:28.861197"
20	},
21	"eventName": "leadAccepted",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadAssigned

A lead was assigned by the system or a concierge. This lead has not yet been routed to the assigned agent. You may wish to examine the leadAccepted event as an alternative, based on your needs.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Lead Name",
4		"email": ["lead@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"assignment": {
12		"tag": "buyer",
13		"role": "member",
14		"assignedTo": "agent@example.com",
15		"assignedDateTime": "2018-06-28T15:28:50.255453"
16	},
17	"eventName": "leadAssigned",
18	"webhookUrl": "https://example.com/webhookEndpoint",
19	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
20}

leadClaimed

A lead was claimed by a concierge. This event will create an assignment on the lead with the role of concierge.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": null,
16		"role": "concierge",
17		"claimedBy": "concierge@example.com",
18		"claimedDateTime": "2018-06-23T20:40:03.77967",
19		"assignedConciergeId": null
20	},
21	"eventName": "leadClaimed",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadClaimedByAgent

A lead was claimed by an agent from the Unclaimed Leads queue.

This event will immediately be followed by the leadAccepted event. You may wish to use that event instead, depending on your needs.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "scrubber",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedDateTime": "2018-06-23T20:34:28.861197",
19		"assignedAgentId": null
20	},
21	"eventName": "leadClaimedByAgent",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadClaimTakeover

The concierge role on a lead was taken by another concierge.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": null,
16		"role": "concierge",
17		"claimedBy": "concierge@example.com",
18		"claimedDateTime": "2018-06-23T20:40:03.77967",
19		"assignedConciergeId": null
20	},
21	"eventName": "leadClaimTakeover",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadDeclined

A lead was declined by an assigned agent.

If this lead was assigned to multiple agents (a "jump ball" assignment), each of the other assignments will eventually trigger a leadExpired, leadDeclined, leadAccepted, or leadSlowAccepted event.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`reason`	string	No	The provided reason for declining the lead
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Lead Name",
4		"email": ["lead@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"assignment": {
12		"tag": "scrubber",
13		"role": "member",
14		"assignedTo": "agent@example.com",
15		"declinedDateTime": "2018-06-28T15:24:40.764885",
16		"assignedAgentId": null
17	},
18	"eventName": "leadDeclined",
19	"reason": "Out of service area",
20	"webhookUrl": "https://example.com/webhookEndpoint",
21	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
22}

leadExpired

An assigned lead that was routed to an agent has expired, and the agent is no longer able to accept the lead.

If this lead was assigned to multiple agents (a "jump ball" assignment), this event will trigger for every assignment that was not accepted.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Lead Name",
4		"email": ["lead@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"assignment": {
12		"tag": "scrubber",
13		"role": "member",
14		"assignedTo": "agent@example.com",
15		"expiredDateTime": "2018-06-28T15:24:40.764885",
16		"assignedAgentId": null
17	},
18	"eventName": "leadExpired",
19	"webhookUrl": "https://example.com/webhookEndpoint",
20	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
21}

leadRetracted

A lead that was previously routed was retracted by a concierge. This action will remove the lead from the agent's database.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"retractedDateTime": "2018-06-29T12:25:16.422922",
19		"assignedAgentId": null
20	},
21	"eventName": "leadRetracted",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadRouted

An assigned lead was routed to an agent (via the system or a concierge). This means the agent has received notification of the new lead, but they have not yet accepted the lead. (You may wish to subscribe to the leadAccepted event instead of this one.)

If multiple agents are assigned a lead (a "jump ball" assignment), and the lead is routed, this event will trigger for each assigned agent.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Lead Name",
4		"email": ["lead@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"assignment": {
12		"tag": "scrubber",
13		"role": "member",
14		"assignedTo": "agent@example.com",
15		"routedDateTime": "2018-06-28T15:34:48.093157",
16		"assignedAgentId": null
17	},
18	"auto_accept": false,
19	"eventName": "leadRouted",
20	"webhookUrl": "https://example.com/webhookEndpoint",
21	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
22}

leadSlowAccepted

An agent attempted to accept a lead (by clicking the "Accept" button on the lead form), but was unable to accept because another assigned agent accepted it first.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Lead Name",
4		"email": ["lead@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"assignment": {
12		"tag": "scrubber",
13		"role": "member",
14		"assignedTo": "agent@example.com",
15		"slowAcceptedDateTime": "2018-06-28T15:24:40.764885",
16		"assignedAgentId": null
17	},
18	"eventName": "leadSlowAccepted",
19	"webhookUrl": "https://example.com/webhookEndpoint",
20	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
21}

Deal Management

After an agent accepts a lead, they can add a deal (buyer, seller, renter) and perform actions that move the lead through the deal lifecycle. These events track the deal-related actions.

appAccepted

A leasing agent indicated their renter's application has been accepted by the landlord. This deal will now be marked as closed and will be automatically archived.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "renter",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "appAccepted",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

appRejected

A leasing agent indicated their renter's submitted application was rejected by the landlord.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`reason`	string	No	The reason the application was rejected
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "renter",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "appRejected",
21	"reason": "Credit check failure",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

appSubmitted

A leasing agent indicated their renter has submitted an application to a landlord.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "renter",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "appSubmitted",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

closingCanceled

An agent indicated the scheduled closing has been canceled.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`reason`	string	No	The reason the closing was canceled
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "cloingCanceled",
21	"reason": "Lost financing",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

closingRescheduled

The agent specified that the closing date has moved.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`closingDate`	datetime (ISO 8601)	No	The new closing date
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "closingRescheduled",
21	"closingDate": "2018-06-29T00:00:00",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

closingScheduled

The agent has specified that a lead has scheduled a closing.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`closingDate`	datetime (ISO 8601)	No	The scheduled closing date
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "closingScheduled",
21	"closingDate": "2018-06-29T00:00:00",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

dealClosed

The agent has specified that their customer has closed their real estate transaction. This deal will now be marked as closed and will be automatically archived.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "dealClosed",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

dealCreated

A deal defines an agent-customer relationship, and tracks the status of that relationship through the closing. Each deal has a tag that identifies the customer need. Valid tags are:

Buyer: the customer is a prospective buyer
Seller: the customer is selling their home
Renter: the customer is looking to rent a home
Scrubber: the tag is not yet determined (the customer is still being scrubbed by the agent)

This event tracks the creation of a new deal on a lead. This deal can be created by a concierge or agent, or automatically by the system's assignment rules.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment (including the deal tag)
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "dealCreated",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

dealDeleted

A deal was removed, probably in preparation for creating a new deal.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "dealDeleted",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

offerAccepted

The offer received (seller) or offer sent (buyer) was accepted by the other party.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "offerAccepted",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

offerReceived

An agent indicated their seller received an offer on the listing.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "offerReceived",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

offerSent

The agent indicated an offer was sent by a buyer they represent.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "offerSent",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

Other Webhooks

These events occur outside of deals, assignments, or routing, but may still be valuable for your system.

leadAwoken

A snoozed lead has awoken and was placed into the users "Active" queue. Leads can be manually awoken by the user, or automatically based on a scheduled date and time.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "leadAwoken",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

leadCalled

The user called the lead on the telephone. A result is also supplied, and must be chosen from a list by the user. Valid results are:

Reached
Left voicemail
Busy/No answer
Wrong Number

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`result`	string	No	The result of the telephone call
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"result": "Left voicemail",
21	"eventName": "leadCalled",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadEmailed

The user sent the lead an email message.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`message`	object	No	The details of the email message
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "leadEmailed",
21	"message": "Hi Sally, let's meet on Sunday to look at some properties.",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadJunked

The lead was junked by a concierge. Note that agents do not have permission to junk a lead; they can only mark a lead as inactive. See leadMarkedInactive.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`reason`	string	No	The reason the lead was junked
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "leadJunked",
21	"reason": "Spam or fake account"
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadLifecycleUpdated

The lead's lifecycle phase was manually changed by the user.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`lifecycleState`	object	No	An object describing the current state of the lead's lifecycle
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "leadLifecycleUpdated",
21	"lifecycleState": "Reached",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadMarkedInactive

The lead was marked inactive by the assigned user. Leads can be marked as inactive manually, or automatically if the deal on the lead is closed.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`reason`	string	No	The reason the lead was marked inactive
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "leadMarkedInactive",
21	"reason": "Lost contact",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadReachedInPerson

The agent has had an initial meeting with the lead.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "leadReachedInPerson",
21	"webhookUrl": "https://example.com/webhookEndpoint",
22	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
23}

leadSnoozed

The lead was snoozed by the user.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`wakeDateTime`	timestamp (ISO 8601)	No	The date and time the lead is scheduled to wake
`reason`	string	No	The user-customizable reason for snoozing the lead
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "leadSnoozed",
21	"wakeDateTime": "2018-06-29T12:25:16.422922",
22	"reason": "Customer asked to call back Saturday.",
23	"webhookUrl": "https://example.com/webhookEndpoint",
24	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
25}

leadTexted

The assigned user sent the lead a text message.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`message`	string	No	The message sent to the lead
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"aid": "13cd31bc-bdeb-4c0a-a940-990af8ee4bb8",
4		"name": "Lead Name",
5		"email": ["lead@example.com"],
6		"phone": ["5555555555"],
7		"leadId": 1234,
8		"source": "www.example.com",
9		"userId": "c0b70a35-fc9c-4236-919d-5ba145d28775",
10		"account": "Team Name",
11		"teamEmail": "team_email@bryteagent.com",
12		"boostedAPIKey": "ae7d56b1-1276-459a-b6e4-117df2379cf4"
13	},
14	"assignment": {
15		"tag": "buyer",
16		"role": "member",
17		"assignedTo": "agent@example.com",
18		"assignedAgentId": null
19	},
20	"eventName": "leadTexted",
21	"message": "Hi Susan, can you meet tomorrow at noon?",
22	"webhookUrl": "https://example.com/webhookEndpoint",
23	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
24}

leadUpdated

A user has updated the lead information, such as name or email address.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the assignment related to the person who updated the lead
`updatedData`	object	No	An object containing the data fields that were changed, and their old and new values
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Lead Name",
4		"email": ["lead@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"assignment": {
12		"tag": "scrubber",
13		"role": "member",
14		"assignedTo": "agent@example.com",
15		"assignedAgentId": null
16	},
17	"updatedData": {
18		"name": {
19			"old": "Fredreick",
20			"new": "Frederick"
21		}, "telephone": {
22			"old": ["8005551212"],
23			"new": ["8005551212","8005551213"]
24		}, "primaryTelephone": {
25			"old": "8005551212",
26			"new": "8005551213"
27		}
28	},
29	"eventName": "leadUpdated",
30	"webhookUrl": "https://example.com/webhookEndpoint",
31	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
32}

System Webhooks

These events are triggered by system rules or business logic. Except in some specific cases of leadCreated, these events are not triggered directly by user actions.

leadBehaviorAlert

This lead's online behavior has indicated an agent should contact them for assistance.

Note that the lead has not directly asked for an agent, and they may already have an assigned agent.

This event is designed not to trigger on leads that are actively being managed by an agent.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

leadCreated

A lead was created in Lead Voyager. This happens before assigning or routing a lead.

Field	Type	Required	Description
`lead`	lead	No	The lead that was created
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Lead Name",
4		"email": ["lead@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"eventName": "leadCreated",
12	"webhookUrl": "https://yourwebsite/webhookEndpoint",
13	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
14}

leadNeedsAttention

An issue has occurred with this lead, and it now needs human intervention.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`eventName`	string	No	The name of this event
`reason`	string	No	The reason this alert occurred
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Lead Name",
4		"email": ["lead@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"eventName": "leadNeedsAttention",
12	"reason": "Unable to auto-assign this lead.",
13	"webhookUrl": "https://yourwebsite/webhookEndpoint",
14	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
15}

messageReceived

A lead has submitted a message, which can be a form, email, email reply, or other inbound message type supported by the broker. Assigned agents will receive notification of this message.

If this message applies to multiple assignments, it will trigger for each.

Field	Type	Required	Description
`lead`	lead	No	The related lead
`assignment`	assignment	No	The details of the agent assignment
`message`	object	No	The details of the message
`eventName`	string	No	The name of this event
`webhookUrl`	string	No	The URL to which this webhook was posted
`messageId`	string	No	The unique ID of this message

1{
2	"lead": {
3		"name": "Johnny Lead",
4		"email": ["johnny@example.com"],
5		"phone": ["5555555555"],
6		"leadId": 1234,
7		"source": "Source Name",
8		"account": "Team Name",
9		"teamEmail": "team_email@bryteagent.com"
10	},
11	"message": {
12		"id": 1133723,
13		"message_type": 1,
14		"message_type_name": "form",
15		"created_ts": "2018-08-05T22:29:33.788Z",
16		"event": "realestate.requestedShowing",
17		"form": {
18			"fromEmail": "johnny@example.com",
19			"fromName": "Johnny Lead",
20			"fromTelephone": "5555555555",
21			"isWorkingWithAgent": false,
22			"name": "My Website Schedule a Showing",
23			"message": "Hi I'm looking to schedule a showing for 1234 Main Street.",
24			"relatedListing": {
25				"address": {
26					"streetAddress": "1234 Main St.",
27					"city": "Lincoln",
28					"stateProvince": "NE",
29					"zipPostal": "68501"
30				},
31				"bedrooms": 4,
32				"fullBaths": 2,
33				"geoLocation": {
34				},
35				"halfBaths": 1
36				...
37			}
38			"subject": "Schedule a Showing",
39		}
40	},
41	"eventName": "messageReceived",
42	"webhookUrl": "https://example.com/webhookEndpoint",
43	"messageId": "44089235-be19-4ebf-ba86-bdfc154d20c0"
44}

Updated July 24, 2026