Brand Webhooks
Overview
Brand webhooks allow you to receive real-time notifications when specific events occur for your brand. Currently supported topics include ‘Deals’, ‘Showings’, ‘Contacts’, and ‘Activities’.
Resource Group ¶
Create Brand Webhook ¶
Create Brand WebhookPOST/brands/:id/webhooks
Creates a new webhook for a brand that will receive notifications for the specified topic.
The webhook’s secret key is returned in the info object of this response and nowhere else. Store it at creation time; it cannot be retrieved later. If it’s lost, delete the webhook and create a new one.
Example URI
POST /brands/:id/webhooks
URI Parameters
- id
string(required) Example: e4549a82-58eb-48f3-b302-d1d53f91acfc
Request
Body
{
"topic": "Showings",
"url": "https://localhost:3000"
}Response
200Body
{
"code": "OK",
"data": {
"id": "c48306ac-8217-4827-9c95-35e9e6b88146",
"created_at": 1791656407.459908,
"updated_at": 1791656407.459908,
"deleted_at": null,
"brand": "e4549a82-58eb-48f3-b302-d1d53f91acfc",
"topic": "Showings",
"url": "https://localhost:3000",
"tags": null,
"type": "brand_webhook"
},
"info": {
"key": "7de8b1c1bb2f6fe9a56852498c424e4ba554acc392672f44066a727da670350a"
}
}Get All Brand Webhooks ¶
Get All Brand WebhooksGET/brands/:id/webhooks
Gets a list of all webhooks for a brand. Does not return deleted records. To fetch a list of brand webhooks for a specific topic, use the topic query parameter.
Example URI
GET /brands/:id/webhooks
URI Parameters
- id
string(required) Example: e4549a82-58eb-48f3-b302-d1d53f91acfc
Response
200Body
{
"code": "OK",
"data": [
{
"id": "c48306ac-8217-4827-9c95-35e9e6b88146",
"created_at": 1791656407.459908,
"updated_at": 1791656407.459908,
"deleted_at": null,
"brand": "e4549a82-58eb-48f3-b302-d1d53f91acfc",
"topic": "Showings",
"url": "https://localhost:3000",
"tags": null,
"type": "brand_webhook"
}
],
"info": {
"count": 1,
"total": 0
}
}Delete Brand Webhook ¶
Delete Brand WebhookDELETE/brands/:id/webhooks/:wid
Deletes a specific webhook for a brand.
Example URI
DELETE /brands/:id/webhooks/:wid
URI Parameters
- id
string(required) Example: e4549a82-58eb-48f3-b302-d1d53f91acfc- wid
string(required) Example: c48306ac-8217-4827-9c95-35e9e6b88146
Response
204Body
**Deprecation notice: the 'Activities' topic is due for deprecation and must not be used.**
Webhooks on the 'Activities' topic are called when an activity is recorded on a contact's timeline. The `event` field is the activity's action, such as `ContactViewedListing` or `ContactLeadCaptured`. Depending on the action, the activity carries a `listing`, `lead`, or `search` key in the same format the timeline endpoints accept them in:
{
"topic": "Activities",
"event": "ContactViewedListing",
"timestamp": 1786515688070,
"payload": {
"activity": {
"id": "...",
"action": "ContactViewedListing",
"created_at": 1786515688,
"contact": "...",
"listing": {
"id": "...",
"mls": "...",
"mls_number": "...",
"status": "Active",
"price": 500000,
"address": "123 Main St, Dallas, TX 75201"
}
}
}
}