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’, and ‘Contacts’.
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.
Example URI
POST /brands/:id/webhooks
URI Parameters
- id
string(required) Example: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20
Request
Body
{
"topic": "Showings",
"url": "https://localhost:3000"
}Response
200Body
{
"code": "OK",
"data": {
"id": "be4765e1-dfa7-4bab-802f-4519008c793f",
"created_at": 1760469964.101311,
"updated_at": 1760469964.101311,
"deleted_at": null,
"brand": "720e8b69-0ed3-497e-86d0-80fc2dfcfe20",
"topic": "Showings",
"url": "https://localhost:3000",
"key": "dac0f110a06dd74cddea6ef20fe843428ff8f68549d820f6221ab3e66a3c92e6",
"tags": null,
"type": "brand_webhook"
}
}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: 720e8b69-0ed3-497e-86d0-80fc2dfcfe20- wid
string(required) Example: be4765e1-dfa7-4bab-802f-4519008c793f
Response
204Body
All webhook requests include an HMAC-SHA256 signature in the headers for verification. The signature is generated using the webhook's secret key and should be validated to ensure the authenticity of incoming webhook calls.