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: 8929cf8b-6bcc-484a-a7a6-242eaf70cb7a
Request
Body
{
"topic": "Showings",
"url": "https://localhost:3000"
}Response
200Body
{
"code": "OK",
"data": {
"id": "d9dc8237-9515-4832-ad51-c77978fc1c13",
"created_at": 1774173334.258162,
"updated_at": 1774173334.258162,
"deleted_at": null,
"brand": "8929cf8b-6bcc-484a-a7a6-242eaf70cb7a",
"topic": "Showings",
"url": "https://localhost:3000",
"key": "16b43e2f5379346d4e605f4389c8366bece1756a22fbef3a7906549d8eaf097e",
"tags": null,
"type": "brand_webhook"
}
}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: 8929cf8b-6bcc-484a-a7a6-242eaf70cb7a
Response
200Body
{
"code": "OK",
"data": [
{
"id": "d9dc8237-9515-4832-ad51-c77978fc1c13",
"created_at": 1774173334.258162,
"updated_at": 1774173334.258162,
"deleted_at": null,
"brand": "8929cf8b-6bcc-484a-a7a6-242eaf70cb7a",
"topic": "Showings",
"url": "https://localhost:3000",
"key": "16b43e2f5379346d4e605f4389c8366bece1756a22fbef3a7906549d8eaf097e",
"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: 8929cf8b-6bcc-484a-a7a6-242eaf70cb7a- wid
string(required) Example: d9dc8237-9515-4832-ad51-c77978fc1c13
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.