List Webhook Event REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:49:59 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:49:59

GET api.ashx/v2/webhooks/events.{json|xml}

Request Parameters

Name	Type	Location	Description	Required
CallBackUrl	string	Query String	Filter to the events this url is subscribed to	Optional
PageIndex	int	Query String	Page index for the results	Optional
PageSize	int	Query String	Page size for the results	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/webhooks/events.json'
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "WebhookEvents": [
    {
      "Name": "name",
      "Description": "description",
      "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e",
      "MessageType": "messagetype"
    },
    {
      "Name": "name",
      "Description": "description",
      "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
      "MessageType": "messagetype"
    }
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <WebhookEvents PageSize="2" PageIndex="0" TotalCount="2">
    <RestWebhookEvent>
      <Name>name</Name>
      <Description>description</Description>
      <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
      <MessageType>messagetype</MessageType>
    </RestWebhookEvent>
    <RestWebhookEvent>
      <Name>name</Name>
      <Description>description</Description>
      <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
      <MessageType>messagetype</MessageType>
    </RestWebhookEvent>
  </WebhookEvents>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>