List Webhook REST Endpoint

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

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

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

Example Requests

Widget Javascript

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

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "Webhooks": [
    {
      "Url": "url",
      "Id": 6,
      "IsEnabled": true,
      "Events": [
        {
          "Name": "name",
          "Description": "description",
          "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e",
          "MessageType": "messagetype"
        },
        {
          "Name": "name",
          "Description": "description",
          "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
          "MessageType": "messagetype"
        }
      ]
    },
    {
      "Url": "url",
      "Id": 25,
      "IsEnabled": true,
      "Events": [
        {
          "Name": "name",
          "Description": "description",
          "Id": "fe65240b-044c-4292-9946-f10e0361ecff",
          "MessageType": "messagetype"
        },
        {
          "Name": "name",
          "Description": "description",
          "Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
          "MessageType": "messagetype"
        }
      ]
    }
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Webhooks PageSize="2" PageIndex="0" TotalCount="2">
    <RestWebhook>
      <Url>url</Url>
      <Id>6</Id>
      <IsEnabled>true</IsEnabled>
      <Events 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>
      </Events>
    </RestWebhook>
    <RestWebhook>
      <Url>url</Url>
      <Id>25</Id>
      <IsEnabled>true</IsEnabled>
      <Events PageSize="2" PageIndex="0" TotalCount="2">
        <RestWebhookEvent>
          <Name>name</Name>
          <Description>description</Description>
          <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
          <MessageType>messagetype</MessageType>
        </RestWebhookEvent>
        <RestWebhookEvent>
          <Name>name</Name>
          <Description>description</Description>
          <Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id>
          <MessageType>messagetype</MessageType>
        </RestWebhookEvent>
      </Events>
    </RestWebhook>
  </Webhooks>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>