> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.brevo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server. # Create a webhook POST https://api.brevo.com/v3/webhooks Content-Type: application/json Creates a new webhook to receive real-time notifications for specified events. Use this to: - Set up event notifications for transactional or marketing emails - Configure webhook endpoints for campaign tracking - Enable real-time monitoring of email delivery status - Subscribe to contact list changes and updates - Implement custom event handling and automation Key information returned: - Created webhook ID and configuration - Success confirmation and setup details Reference: https://developers.brevo.com/reference/create-webhook ## Authentication - `api-key` header (required) — The API key should be passed in the request headers as `api-key` for authentication. - `Authorization` header (bearer token, required) — OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app's client_id/client_secret for a short-lived Bearer token. ## Request ### Body (application/json) This endpoint expects an object. - `url` (string, required) — URL of the webhook - `auth` (WebhooksPostRequestBodyContentApplicationJsonSchemaAuth, optional) — Add authentication on webhook url - `batched` (boolean, optional) — To send batched webhooks - `channel` (enum, optional, default: email) — Channel of the webhook - Allowed values: `email`, `sms` - `description` (string, optional) — Description of the webhook - `domain` (string, optional) — Inbound domain of webhook, required in case of event type `inbound` - `events` (list of enum, optional) — Events triggering the webhook. Required for transactional and marketing types, optional for inbound type (defaults to `inboundEmailProcessed`). Possible values for **Transactional** type webhook: `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed`. Possible values for **Marketing** type webhook: `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition`, `delivered`, `contactUpdated` & `contactDeleted`. Possible values for **Inbound** type webhook: `inboundEmailProcessed`. - Allowed values: `sent`, `hardBounce`, `softBounce`, `blocked`, `spam`, `delivered`, `request`, `click`, `invalid`, `deferred`, `opened`, `uniqueOpened`, `unsubscribed`, `listAddition`, `contactUpdated`, `contactDeleted`, `inboundEmailProcessed`, `reply` - `headers` (list of WebhooksPostRequestBodyContentApplicationJsonSchemaHeadersItems, optional) — Custom headers to be send with webhooks - `type` (enum, optional, default: transactional) — Type of the webhook - Allowed values: `transactional`, `marketing`, `inbound` ## Response ### 201 successfully created - `id` (long, required) — ID of the object created ## Errors ### 400 Bad Request Error bad request - `code` (enum, required) — Error code displayed in case of a failure - Allowed values: `invalid_parameter`, `missing_parameter`, `out_of_range`, `campaign_processing`, `campaign_sent`, `document_not_found`, `not_enough_credits`, `permission_denied`, `duplicate_parameter`, `duplicate_request`, `method_not_allowed`, `unauthorized`, `account_under_validation`, `not_acceptable`, `bad_request`, `unprocessable_entity`, `Domain does not exist`, `Contact email not found`, `Attribute not found`, `Category id not found`, `Invalid parameters passed`, `Record(s) for identifier not found`, `Returned when query params are invalid`, `Returned when invalid data posted`, `Feed not found`, `Campaign ID not found`, `api-key not found`, `DMARC policy requires domain authentication`, `DNS records not properly configured`, `Invalid OTP code provided`, `OTP code has expired`, `Domain already exists in your account`, `The sum of all IP weights must equal 100`, `Authentication failed`, `Insufficient credits`, `Request already processed` - `message` (string, required) — Readable message associated to the failure ## Types ### WebhooksPostRequestBodyContentApplicationJsonSchemaAuth Add authentication on webhook url - `token` (string, optional) — Webhook authentication token - `type` (string, optional) — Type of authentication ### WebhooksPostRequestBodyContentApplicationJsonSchemaHeadersItems - `key` (string, optional) — Header key name - `value` (string, optional) — Header value ## Examples **Request** ```json { "url": "http://requestb.in/173lyyx1" } ``` **Response** ```json { "id": 5 } ``` **SDK Code** ```python import requests url = "https://api.brevo.com/v3/webhooks" payload = { "url": "http://requestb.in/173lyyx1" } headers = { "api-key": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.brevo.com/v3/webhooks'; const options = { method: 'POST', headers: {'api-key': '', 'Content-Type': 'application/json'}, body: '{"url":"http://requestb.in/173lyyx1"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.brevo.com/v3/webhooks" payload := strings.NewReader("{\n \"url\": \"http://requestb.in/173lyyx1\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("api-key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.brevo.com/v3/webhooks") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["api-key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"url\": \"http://requestb.in/173lyyx1\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.brevo.com/v3/webhooks") .header("api-key", "") .header("Content-Type", "application/json") .body("{\n \"url\": \"http://requestb.in/173lyyx1\"\n}") .asString(); ``` ```php request('POST', 'https://api.brevo.com/v3/webhooks', [ 'body' => '{ "url": "http://requestb.in/173lyyx1" }', 'headers' => [ 'Content-Type' => 'application/json', 'api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.brevo.com/v3/webhooks"); var request = new RestRequest(Method.POST); request.AddHeader("api-key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"url\": \"http://requestb.in/173lyyx1\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "api-key": "", "Content-Type": "application/json" ] let parameters = ["url": "http://requestb.in/173lyyx1"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.brevo.com/v3/webhooks")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```