POST api/webhooks/registrations

Registers a new WebHook for a given user.

Request Information

URI Parameters

None.

Body Parameters

The to create.

Name	Description	Type	Additional information
Id	Gets or sets a unique ID of the WebHook. This ID can be used to later refer to the WebHook in case it needs to be updated or deleted. The ID is by default in the form of a and if the field is cleared it will be reset to a .	string	-
WebHookUri	Gets or sets the URI of the WebHook.	URI	Required
Secret	Gets or sets the secret used to sign the body of the WebHook request.	string	-
Description	Gets or sets a description of the WebHook.	string	-
IsPaused	Gets or sets a value indicating whether the WebHook is paused.	boolean	-
Filters	Gets the set of case-insensitive filters associated with this WebHook. The filters indicate which WebHook events that this WebHook will be notified for. The list of filters can be obtained from the registered instance.	Collection of string	-
Headers	Gets a set of additional HTTP headers that will be sent with the WebHook request.	Dictionary of string [key] and string [value]	-
Properties	Gets a set of additional case-insensitive properties that will be sent with the WebHook request as part of the HTTP request entity body.	Dictionary of string [key] and Object [value]	-

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "WebHookUri": "http://webapihelppage2.com",
  "Secret": "sample string 3",
  "Description": "sample string 4",
  "IsPaused": true,
  "Filters": [],
  "Headers": {},
  "Properties": {}
}

application/xml, text/xml

Sample:

<WebHook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.WebHooks">
  <Description>sample string 4</Description>
  <Headers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <Id>sample string 1</Id>
  <IsPaused>true</IsPaused>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <Secret>sample string 3</Secret>
  <WebHookUri>http://webapihelppage2.com/</WebHookUri>
</WebHook>

Response Information

Resource Description

WebHook

Name	Description	Type	Additional information
Id	Gets or sets a unique ID of the WebHook. This ID can be used to later refer to the WebHook in case it needs to be updated or deleted. The ID is by default in the form of a and if the field is cleared it will be reset to a .	string	-
WebHookUri	Gets or sets the URI of the WebHook.	URI	Required
Secret	Gets or sets the secret used to sign the body of the WebHook request.	string	-
Description	Gets or sets a description of the WebHook.	string	-
IsPaused	Gets or sets a value indicating whether the WebHook is paused.	boolean	-
Filters	Gets the set of case-insensitive filters associated with this WebHook. The filters indicate which WebHook events that this WebHook will be notified for. The list of filters can be obtained from the registered instance.	Collection of string	-
Headers	Gets a set of additional HTTP headers that will be sent with the WebHook request.	Dictionary of string [key] and string [value]	-
Properties	Gets a set of additional case-insensitive properties that will be sent with the WebHook request as part of the HTTP request entity body.	Dictionary of string [key] and Object [value]	-

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "WebHookUri": "http://webapihelppage2.com",
  "Secret": "sample string 3",
  "Description": "sample string 4",
  "IsPaused": true,
  "Filters": [],
  "Headers": {},
  "Properties": {}
}

application/xml, text/xml

Sample:

<WebHook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AspNet.WebHooks">
  <Description>sample string 4</Description>
  <Headers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <Id>sample string 1</Id>
  <IsPaused>true</IsPaused>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <Secret>sample string 3</Secret>
  <WebHookUri>http://webapihelppage2.com/</WebHookUri>
</WebHook>