1. v3
  2. Hooks
  3. GET - 3/hooks/events

Definition

GET - 3/hooks/events

Retrieve the available events to which you can attach your web hooks.

Response cached for 86400 seconds.

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type WebhookEvent
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-03T17:09:20.2176892Z",
    "IsFiltered": true
  },
  "Data": {
    "EventName": "sample string 2",
    "SurveyIdRequired": true,
    "SurveyIdAvailable": true
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data z:Id="i2">
    <EventName>sample string 2</EventName>
    <SurveyIdAvailable>true</SurveyIdAvailable>
    <SurveyIdRequired>true</SurveyIdRequired>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-12-03T17:09:20.2176892+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>