WebHook

Describes the contents and behavior or a WebHook. A is similar to a subscription in a pub/sub system in that it allows the subscriber to indicate when and how event notifications should get dispatched and where they should get dispatched to. A is registered and managed on a per user basis which means that each user has a separate set of WebHooks that can get trigged by actions executed by that user. That is, user A will not see a WebHook fired for an action performed by user B.

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	None.
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	None.
Description	Gets or sets a description of the WebHook.	string	None.
IsPaused	Gets or sets a value indicating whether the WebHook is paused.	boolean	None.
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	None.
Headers	Gets a set of additional HTTP headers that will be sent with the WebHook request.	Dictionary of string [key] and string [value]	None.
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]	None.