POST api/v1/webhooks/notification/user
Request Information
URI Parameters
None.
Body Parameters
WHMessageBodyName | 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": "26d34d7d-879a-4196-a0c0-613baea4d64c", "targetsId": [ "411c1c13-bc30-4027-be0b-2792ae5ab44c", "83b32f6f-e758-4710-94d8-38bf8cfdae0c" ], "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>26d34d7d-879a-4196-a0c0-613baea4d64c</TargetId> <TargetsId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>411c1c13-bc30-4027-be0b-2792ae5ab44c</d2p1:guid> <d2p1:guid>83b32f6f-e758-4710-94d8-38bf8cfdae0c</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.