PEC-Developer/Current/WebAPIs/Third-party messaging webhook - Revision history

WikiSysop: Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Third-Party Messaging Webhook }} == Base path: /nexus/v3 ==

2023-11-26T04:31:32Z

Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Third-Party Messaging Webhook }} == Base path: /nexus/v3 ==  <div class="web-api-post mw-co..."

New page
{{ArticleUnstructured
|Standalone=No
|DisplayName=Third-Party Messaging Webhook
}}

== Base path: /nexus/v3 ==


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/some/webhook/path</div>
<div class="web-api-summary">Send a message to the third-party system</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Send a message to the third-party system. Refer to OutgoingSmsMessage and OutgoingEmailMessage models for examples and channel-specific differencies.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| X-Hub-Signature
|
| The request signature, for example <tt>sha1=hash</tt>. 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
|-
| colspan=6 |
{|
| <source>
{}
</source>
|
|}
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Message has been sent
|-
| colspan=2 |
{|
| <source>
{
"messageId": "string"
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> OutgoingMessageResponse </div>
|-
| style="text-align:right;" | messageId
| (string):
Unique message ID
|-
|}
|}
|-
| 500
| Error occured while sending message
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
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?"
</source>
</div>
</div>