SMS - Callback inbound endpoint

Endpoint for receiving one or multiple inbound webhook events. Actual URL must be set manually by customers. Inbound events are incoming messages routed from the end user's mobile device.

🚧

Disclaimer: Intended Use of Channel API

The Channel API documentation is designed exclusively for partners who have established commercial agreements with Bloomreach, including CPaaS vendors (Communications Platform as a Service) and MTAs (Mail Transfer Agents, also known as ESPs), such as Mailgun, Sinch, Infobip, Omnivery and others. This API enables our partners to build connectors to their systems effectively and aligns with our service offerings.
Please note that this API is not intended for general client use. If you are an existing client and are interested in Channel API, please contact your account manager.

Query Params
string
required
Defaults to abc123

ID of the BR project. Must be included in URL during manual setup of this endpoint Examples: abc123

Body Params
array of objects
required

One or multiple inbound webhook events. Batching may be used to reduce overhead but is optional.

Headers
string
required
Defaults to 123

JSON Web Token containing iat (issued at) claim - numeric unix timestamp in seconds. The validity period of iat is set to 15 minutes. JWT must be signed with provider's secret string (e.g. API key) using HS256 (HMAC with SHA-256).

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 123

Responses

Language
Response
Choose an example:
application/json

© Bloomreach, Inc. All rights reserved.