Description List the Webhooks registered in the Event Hub. This list can be filtered by search criteria that is specified in the parameters section.  
URL Structure
{Base URL}/webhooks?{search_criteria}
{Base URL}/webhooks Version 3 will return the webhook that is registered.
HTTP Method GET  
Authentication Required  
Request Headers none
Parameters
search_criteria Required? Explanation
identity_id= Optional Limits the list to an exact match on the 'identity_id' attribute. By definition, this will only return one endpoint. It doesn't make any sense to use this parameter with other parameters.
identity_name= Optional Limits the list where the 'identity_name' attribute matches the string expression. The string may include a wild character ('*').
endpoint= Optional Limits the list where the 'endpoint' attribute matches the string expression. The string may include a wild character ('*').
push_option= Optional Limits the list to an exact match on the 'push_option' attribute. The options are 'Push Message' or 'Push Alert'.

Note: When multiple parameters are provided, they are ANDed together. You are not allowed to provide two different instances of the same parameter in the same request. For example, you are not allowed to request '?endpoint=*hr.byu.edu*&endpoint=*fs.byu.edu' in an attempt to get all webhooks for the hr.byu.edu or the fs.byu.edu hosts. You would have to make two requests.

Example Invocations

{Base URL}/webhooks?identity_id=388219162
{Base URL}/webhooks?identity_name=HR*
 {Base URL}/webhooks?identity_name=HR*&push_option=Push%20Alert
 {Base URL}/webhooks?endpoint=*byu.edu/hr*
 
Request Body

none

 
Returns
<webhooks xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <webhook>
      <identity_id/>      --supplied by Event Hub
      <identity_name/>    --retrieved from PRO
      <endpoint/>         --supplied by Event Hub
      <push_option/>      --supplied by Event Hub 
      <security_option/>  --supplied by Event Hub
      <content_type/>     --supplied by Event Hub
   </webhook>
   ...repeat for every Webhook that satisfies {search_criteria}
</webhooks>
<webhooks xmlns="http://ws.byu.edu/namespace/event-hub/v1">
   <webhook>
      <identity_id>388211692</identity_id>
      <identity_name>HR Benefits System</identity_name>
      <endpoint>https://hr.byu.edu/example/endpoint</endpoint>
      <push_option>Push Message</push_option>
      <security_option>Public Key/Private Key Signing</security_option>
      <content_type>application/json</content_type>
   </webhook>
   <webhook>
      <identity_id>388219162</identity_id>
      <identity_name>HR Student Employment System</identity_name>
      <endpoint>https://hr.byu.edu/example/endpoint2</endpoint>
      <push_option>Push Message</push_option>
      <security_option>Public Key/Private Key Signing</security_option>
      <content_type>application/xml</content_type>
   </webhook>
</webhooks>
{
  "webhooks": {
    "webhook": [
      {
        "identity_id": "388211692",
        "identity_name": "HR Benefits System",
        "endpoint": "https://hr.byu.edu/example/endpoint",
        "push_option": "Push Message",
        "security_option": "Public Key/Private Key Signing",
        "content_type": "application/json"
      },
      {
        "identity_id": "388219162",
        "identity_name": "HR Student Employment System",
        "endpoint": "https://hr.byu.edu/example/endpoint2",
        "push_option": "Push Message",
        "security_option": "Public Key/Private Key Signing",
        "content_type": "application/xml"
      }
    ]
  }
} 

Errors

Return Code Additional Explanation
409 Unknown parameter in search criteria
<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>409</return_code>
   <explanation>
      Unknown parameter in search criteria
   </explanation>
   <error_data>Event_tpe</error_data>
</fault_message>
{
  "fault_message": {
    "return_code": "409",
    "explanation": "Unknown parameter in search criteria",
    "error_data": "Event_tpe"
  }
} 
Notes none