POST api/v1/webhooks/notification/user
Request Information
URI Parameters
None.
Body Parameters
WHMessageBody| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | string |
None. |
|
| OrganizationCode | string |
None. |
|
| TargetId | globally unique identifier |
None. |
|
| TargetsId | Collection of globally unique identifier |
None. |
|
| ExtraData | Dictionary of string [key] and string [value] |
None. |
Request Formats
application/json, text/json
Sample:
{
"message": "sample string 1",
"organizationCode": "sample string 2",
"targetId": "75831866-1b4e-432d-9634-a43028aa11fc",
"targetsId": [
"c1fb3a72-ed60-4bfd-8f5d-7b11ef72d43b",
"b37a48fa-74fd-4ef5-a4b3-69e6d5addcc1"
],
"extraData": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
Sample:
<WHMessageBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.WebHooks">
<ExtraData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</ExtraData>
<Message>sample string 1</Message>
<OrganizationCode>sample string 2</OrganizationCode>
<TargetId>75831866-1b4e-432d-9634-a43028aa11fc</TargetId>
<TargetsId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>c1fb3a72-ed60-4bfd-8f5d-7b11ef72d43b</d2p1:guid>
<d2p1:guid>b37a48fa-74fd-4ef5-a4b3-69e6d5addcc1</d2p1:guid>
</TargetsId>
</WHMessageBody>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.