GET api/WebHookSubscription/Lookup/{id}
<strong>post/Lookup</strong> <br /> Looks up a registered WebHook with the given <paramref name="id" /> for a given user.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
A unique ID of the WebHook. IdstringSets 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 System.Guid and if the field is cleared it will be reset to a System.Guid.WebHookUristringSets the URI of the WebHook.SecretstringSets the secret used to sign the body of the WebHook request.DescriptionstringSets a description of the WebHook.IsPausedbooleanSets a value indicating whether the WebHook is paused.FiltersarrayGets 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 Microsoft.AspNet.WebHooks.IWebHookFilterManagerinstance. HeadersSet of additional HTTP headers that will be sent with the WebHook request. PropertiesSet of additional case-insensitive properties that will be sent with the WebHook request as part of the HTTP request entity body. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The registered <see cref="T:Microsoft.AspNet.WebHooks.WebHook" /> instance for a given device.
WebHook| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| WebHookUri | URI |
Required |
|
| Secret | string |
None. |
|
| Description | string |
None. |
|
| IsPaused | boolean |
None. |
|
| Filters | Collection of string |
None. |
|
| Headers | Dictionary of string [key] and string [value] |
None. |
|
| Properties | Dictionary of string [key] and Object [value] |
None. |
Response Formats
application/json, text/json, text/html
{
"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
<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>