POST api/v1/webhooks/notification/partner

Request Information

URI Parameters

None.

Body Parameters

WHMessageBody
NameDescriptionTypeAdditional 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": "6b86a2c6-9d27-4a01-acc3-afcafaa02e5e",
  "targetsId": [
    "2ab55671-29c0-405c-b516-5bf9e0ed2b65",
    "94a49935-233b-45c6-afb8-d02676a7c11e"
  ],
  "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>6b86a2c6-9d27-4a01-acc3-afcafaa02e5e</TargetId>
  <TargetsId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>2ab55671-29c0-405c-b516-5bf9e0ed2b65</d2p1:guid>
    <d2p1:guid>94a49935-233b-45c6-afb8-d02676a7c11e</d2p1:guid>
  </TargetsId>
</WHMessageBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.