POST api/webhooks

Create a new webhook subscription. POST api/webhooks

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

None.

Body Parameters

CreateWebhookView
NameDescriptionTypeAdditional information
Name

string

None.

CallbackUrl

string

None.

Secret

string

None.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "callbackUrl": "sample string 2",
  "secret": "sample string 3"
}

application/xml, text/xml

Sample:
<CreateWebhookView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <CallbackUrl>sample string 2</CallbackUrl>
  <Secret>sample string 3</Secret>
</CreateWebhookView>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WebhookRegisteredView
NameDescriptionTypeAdditional information
Id

string

None.

Name

string

None.

CallbackUrl

string

None.

Secret

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "name": "sample string 2",
  "callbackUrl": "sample string 3",
  "secret": "sample string 4"
}

application/xml, text/xml

Sample:
<WebhookRegisteredView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>sample string 1</Id>
  <Name>sample string 2</Name>
  <CallbackUrl>sample string 3</CallbackUrl>
  <Secret>sample string 4</Secret>
</WebhookRegisteredView>