DELETE api/hooks
This endpoint allows a client to unsubscribe from an event of interest. Afterwards, when the event occurs, the no data will be sent to the previously specified url.
Request Information
URI Parameters
Query String:
None.
Body Parameters
Structure used to terminate a subscription to an event. Required.
Type: WebHookUnsubscription
Name | Description | Type | Additional information |
---|---|---|---|
web_hook_id |
The unique ID of the new subscription. |
globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "web_hook_id": "66619b7c-ed2b-4848-ba66-3bba430f93cd" }
application/xml, text/xml
Sample:
<unsubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <web_hook_id>66619b7c-ed2b-4848-ba66-3bba430f93cd</web_hook_id> </unsubscription>
Response Information
Resource Description
[HTTP Status 200 - OK]
None.