webhooks

Get a webhook details

Retrieves detailed information about a specific webhook configuration.

Use this to:

  • Get complete webhook configuration and settings
  • Check webhook event subscriptions and triggers
  • Review authentication and security settings
  • Verify webhook URL and custom headers
  • Access webhook creation and modification history

Key information returned:

  • Complete webhook details and configuration
  • Event types and channel subscriptions
  • Authentication credentials and methods
  • Custom headers and request settings
  • Webhook status and activity information
get/webhooks/{webhookId}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/webhooks/{webhookId}
  • Auth: API key in header api-key

Path parameters

webhookIdinteger required

Id of the webhook

Response

Webhook informations

authGetWebhookAuth

Authentication header to be send with the webhook requests

batchedboolean

Batching configuration of the webhook, we send batched webhooks if its true

createdAtstring required

Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)

descriptionstring required

Description of the webhook

eventsstring[] required
headersGetWebhookHeadersItems[]
idinteger required

ID of the webhook

modifiedAtstring required

Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)

type'marketing' | 'transactional' | 'inbound' required

Type of webhook (marketing, transactional, or inbound)

domainstring

Inbound domain of the webhook, only returned for inbound type webhooks

urlstring url required

URL of the webhook

Changes

No recorded changes to this operation across all 1 revision of this API.