POST api/Webhook/Subscribe

Subscribe the webhook

Request Information

URI Parameters

None.

Body Parameters

SubscribeModel
NameDescriptionTypeAdditional information
webhookType

WEBHOOK_TYPE

None.

subscriptionType

SUBSCRIPTION_TYPE

None.

endpoint

string

None.

Request Formats

application/json, text/json

Sample:
{
  "webhookType": "NONE",
  "subscriptionType": "NONE",
  "endpoint": "sample string 1"
}

application/xml, text/xml

Sample:
<SubscribeModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <webhookType>NONE</webhookType>
  <subscriptionType>NONE</subscriptionType>
  <endpoint>sample string 1</endpoint>
</SubscribeModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseApiInfo
NameDescriptionTypeAdditional information
UpdateResult

UPDATECODE

None.

isErrorOnRequest

boolean

None.

errorMessage

string

None.

errorMessages

Collection of ErrorInfo

None.

warningMessages

Collection of ErrorInfo

None.

isSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "UpdateResult": "CREATE",
  "isErrorOnRequest": true,
  "errorMessage": null,
  "errorMessages": [],
  "warningMessages": []
}

application/xml, text/xml

Sample:
<xml xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isSuccess>true</isSuccess>
  <UpdateResult>CREATE</UpdateResult>
  <isErrorOnRequest>true</isErrorOnRequest>
  <errorMessages />
  <warningMessages />
</xml>