API reference
HomeEngagementOther resources

Email: Create a webhook

post
https://partner-api-url.com/webhooks

Subscribe webhooks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Channel API access and fees

The Channel API is available to partners and clients who want to build connectors to Communications Platform as a Service (CPaaS) vendors or Mail Transfer Agents (MTAs, also known as ESPs) such as Mailgun, Sinch, Infobip, and Omnivery.

Channel API access isn't enabled by default and is subject to additional fees. To get access, contact your Account Manager.



Query Params
string
required
Defaults to https://brdomain.com/channels/hook/email/myesp/ABC

URL to subscribe and start sending webhook delivery events to if not overridden by callback_url in sentEmail. Examples: https://brdomain.com/channels/hook/email/myesp/ABC

Headers
string
required
Defaults to 123

An example header (one of multiple) containing account identity or authorization data. The actual headers to be sent can be customized to provider's needs, by default BR will send each setting field as a separate header with the prefix Chan- added to the name.

An API key is a token that you provide when making API calls. Include the token in a header parameter called Chan-Example-Token.

Example: Chan-Example-Token: 123

Response

Updated about 1 month ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago

© Bloomreach, Inc. All rights reserved.