Delete Webhook

 

Description

Delete the URL and settings associated with my Push Client. This will not delete my subscriptions. The Event Hub will continue to capture Events for me, but I will have to retrieve them by invoking the Retrieve Events web service or establish a new webhook.

  
URL Structure
{Base URL}/webhooks
HTTP Method DELETE  
Authentication Required  
Request Headers none
Parameters none  
Request Body none  
Returns none  

Errors
Return Code Additional Explanation
401 Only Event Hub Administrators may delete a Webhook for another Entity.
404 Webhook was never defined. 
<fault_message xmlns="http://ws.byu.edu/namespace/event-hub/v1">
  <return_code/>    -- http return code
  <explanation/>    -- see the table above
  <error_data/>     -- from request
</fault_message>
 
<fault_message xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <return_code>404</return_code>
   <explanation>
      Webhook was never defined
   </explanation>
   <error_data>585241162</error_data>
</fault_message>
 
{
  "fault_message": {
    "return_code": "404",
    "explanation": 
      "Webhook was never defined",
    "error_data": "585241162"
  }
}
Notes

This service may be invoked by an Event Hub administrator in behalf of an Event Consuming Application.

The URL Structure is modified in the following fashion:

{Base URL}/webhooks/{identityID}

The identityID is currently defined as the person_id associated with the Event Consuming Application.