Third-Party Messaging Webhook

Base path: /nexus/v3

POST	/some/webhook/path Send a message to the third-party system

Send a message to the third-party system. Refer to OutgoingSmsMessage and OutgoingEmailMessage models for examples and channel-specific differencies.

Parameters

Name	Default	Description	Parameter Type	Data Type	Required
X-Hub-Signature		The request signature, for example sha1=hash. The hash is built using the body of the message and secret for the channel.	header	string	true
X-B3-TraceId		The unique trace ID for the request.	header	string
messages		Message	body		true
{}

Responses

Code	Reason
200	Message has been sent
{ "messageId": "string" } OutgoingMessageResponse messageId (string): Unique message ID
500	Error occured while sending message

Usage

curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{}'
"https://api-demo.com/nexus/v3/some/webhook/path?"