Brevo · Schema

UpdateWebhook

MarketingMarketing AutomationEmail MarketingTransactional EmailSMS MarketingWhatsAppCampaignsCRMSalesE-CommerceLoyaltyEventLive ChatEmailSMSAutomationMessagingContacts

Properties

Name	Type	Description
url	string	Updated URL to receive webhook notifications.
description	string	Updated description.
events	array	Updated list of event types to subscribe to.
domain	string	Updated domain filter.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateWebhook",
  "title": "UpdateWebhook",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Updated URL to receive webhook notifications."
    },
    "description": {
      "type": "string",
      "description": "Updated description."
    },
    "events": {
      "type": "array",
      "description": "Updated list of event types to subscribe to.",
      "items": {
        "type": "string",
        "enum": [
          "sent",
          "request",
          "delivered",
          "hardBounce",
          "softBounce",
          "blocked",
          "spam",
          "invalid",
          "deferred",
          "click",
          "opened",
          "uniqueOpened",
          "unsubscribed",
          "listAddition",
          "inboundEmailProcessed"
        ]
      }
    },
    "domain": {
      "type": "string",
      "description": "Updated domain filter."
    }
  }
}