---
agentTools:
  projectIndex: https://sendinblue.readme.io/llms.txt
---

# /webhooks

Retrieves all webhooks from your Brevo account with filtering and sorting options.

Use this to:
- Monitor webhook configurations and event handling
- List webhooks by type (transactional, marketing, inbound)
- Review webhook endpoints and authentication
- Track webhook creation and modification history
- Audit webhook event subscriptions

Key information returned:
- Complete webhook details and configuration
- Event types and channel subscriptions
- Authentication and security settings
- Webhook URLs and custom headers
- Creation and modification timestamps

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "contact": {
      "email": "contact@brevo.com",
      "name": "Brevo Support",
      "url": "https://account.brevo.com/support"
    },
    "description": "Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :\n  - Manage your campaigns and get the statistics\n  - Manage your contacts\n  - Send transactional Emails and SMS\n  - and much more...\n\nYou can download our wrappers at https://github.com/orgs/brevo\n**Possible responses**\n  | Code | Message |\n  | :-------------: | ------------- |\n  | 200  | OK. Successful Request  |\n  | 201  | OK. Successful Creation |\n  | 202  | OK. Request accepted |\n  | 204  | OK. Successful Update/Deletion  |\n  | 400  | Error. Bad Request  |\n  | 401  | Error. Authentication Needed  |\n  | 402  | Error. Not enough credit, plan upgrade needed  |\n  | 403  | Error. Permission denied  |\n  | 404  | Error. Object does not exist |\n  | 405  | Error. Method not allowed  |\n  | 406  | Error. Not Acceptable  |\n  | 422  | Error. Unprocessable Entity |\n",
    "license": {
      "name": "MIT",
      "url": "http://opensource.org/licenses/MIT"
    },
    "title": "Brevo API",
    "version": "3.0.0"
  },
  "servers": [
    {
      "url": "https://api.brevo.com/v3"
    }
  ],
  "security": [
    {
      "api-key": []
    },
    {
      "partner-key": []
    }
  ],
  "paths": {
    "/webhooks": {
      "get": {
        "operationId": "getWebhooks",
        "parameters": [
          {
            "description": "Filter on webhook type",
            "in": "query",
            "name": "type",
            "schema": {
              "default": "transactional",
              "enum": [
                "marketing",
                "transactional",
                "inbound"
              ],
              "type": "string"
            }
          },
          {
            "description": "Sort the results in the ascending/descending order of webhook creation",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "default": "desc",
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "examples": {
                  "response": {
                    "value": {
                      "webhooks": [
                        {
                          "auth": {
                            "token": "test-auth-token1234",
                            "type": "bearer"
                          },
                          "batched": true,
                          "channel": "email",
                          "createdAt": "2016-07-18T12:30:09Z",
                          "description": "Webhook triggered on campaign openings",
                          "events": [
                            "opened"
                          ],
                          "headers": [
                            {
                              "key": "cf-secret",
                              "value": "test-header-value"
                            }
                          ],
                          "id": 9864,
                          "modifiedAt": "2016-07-18T16:00:50Z",
                          "type": "transactional",
                          "url": "https://example.domain.com/webhook/events/kzfxxxxxxxx0uyo1"
                        },
                        {
                          "channel": "sms",
                          "createdAt": "2017-02-20T14:30:00Z",
                          "description": "Webhook triggered on campaign hard bounces",
                          "events": [
                            "hardBounces"
                          ],
                          "id": 22770,
                          "modifiedAt": "2017-02-20T19:00:00Z",
                          "type": "marketing",
                          "url": "http://exmaple.domain.com/15kxxxxxn1"
                        }
                      ]
                    }
                  }
                },
                "schema": {
                  "properties": {
                    "webhooks": {
                      "items": {
                        "allOf": [
                          {
                            "$ref": "#/components/schemas/getWebhook"
                          }
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    }
                  },
                  "required": [
                    "webhooks"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "Webhooks informations"
          },
          "400": {
            "$ref": "#/components/responses/errorModel"
          }
        },
        "description": "Retrieves all webhooks from your Brevo account with filtering and sorting options.\n\nUse this to:\n- Monitor webhook configurations and event handling\n- List webhooks by type (transactional, marketing, inbound)\n- Review webhook endpoints and authentication\n- Track webhook creation and modification history\n- Audit webhook event subscriptions\n\nKey information returned:\n- Complete webhook details and configuration\n- Event types and channel subscriptions\n- Authentication and security settings\n- Webhook URLs and custom headers\n- Creation and modification timestamps",
        "tags": [
          "Webhooks"
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api-key": {
        "description": "The API key should be passed in the request headers as `api-key` for authentication.",
        "in": "header",
        "name": "api-key",
        "type": "apiKey"
      },
      "partner-key": {
        "description": "The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional).",
        "in": "header",
        "name": "partner-key",
        "type": "apiKey"
      }
    },
    "schemas": {
      "getWebhook": {
        "properties": {
          "auth": {
            "description": "Authentication header to be send with the webhook requests",
            "example": {
              "token": "test-auth-token1234",
              "type": "bearer"
            },
            "type": "object"
          },
          "batched": {
            "description": "Batching configuration of the webhook, we send batched webhooks if its\ntrue",
            "example": true,
            "type": "boolean"
          },
          "channel": {
            "default": "email",
            "description": "channel of webhook",
            "enum": [
              "sms",
              "email"
            ],
            "example": "email",
            "type": "string"
          },
          "createdAt": {
            "description": "Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)",
            "example": "2016-12-01T12:50:00Z",
            "type": "string"
          },
          "description": {
            "description": "Description of the webhook",
            "example": "Webhook triggered on campaign openings",
            "type": "string"
          },
          "events": {
            "items": {
              "description": "Events which will trigger the webhook when they occure",
              "example": "opens,clicks",
              "type": "string"
            },
            "type": "array"
          },
          "headers": {
            "items": {
              "description": "Headers send with the requests to the webhook",
              "example": {
                "key": "cf-secret",
                "value": "test-header-value"
              },
              "type": "object"
            },
            "type": "array"
          },
          "id": {
            "description": "ID of the webhook",
            "example": 654,
            "format": "int64",
            "type": "integer"
          },
          "modifiedAt": {
            "description": "Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)",
            "example": "2017-05-12T13:15:00Z",
            "type": "string"
          },
          "type": {
            "description": "Type of webhook (marketing or transactional)",
            "enum": [
              "marketing",
              "transactional"
            ],
            "example": "marketing",
            "type": "string"
          },
          "url": {
            "description": "URL of the webhook",
            "example": "http://requestb.in/173lyyx1",
            "format": "url",
            "type": "string"
          }
        },
        "required": [
          "createdAt",
          "description",
          "events",
          "id",
          "modifiedAt",
          "type",
          "url"
        ],
        "type": "object"
      }
    },
    "responses": {
      "errorModel": {
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "code": {
                  "description": "Error code displayed in case of a failure",
                  "enum": [
                    "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"
                  ],
                  "example": "method_not_allowed",
                  "type": "string"
                },
                "message": {
                  "description": "Readable message associated to the failure",
                  "example": "POST Method is not allowed on this path",
                  "type": "string"
                }
              },
              "required": [
                "code",
                "message"
              ],
              "type": "object"
            }
          }
        },
        "description": "bad request"
      }
    }
  },
  "x-samples-languages": [
    "curl"
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 91,
      "1": 104,
      "2": 180,
      "3": 205,
      "4": 240,
      "5": 82,
      "6": 207,
      "7": 0,
      "8": 3,
      "9": 36,
      "10": 63,
      "11": 142
    }
  }
}
```