GET webhooks

Returns list of webhooks currently subscribed to

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of WebHook

Name	Description	Type	Additional information
Id	Unqiue identifier	integer	None.
Name	Name of webhook	string	None.
BusinessUnit	Business unit 1712 – ScanSource POS / Barcode 1713 – ScanSource Catalyst 1714 – ScanSource Communications 1715 – ScanSource Security 1718 – ScanSource Networking 2512 – ScanSource EU POS / Barcode 2514 – ScanSource EU Communications 1154 - ScanSource Imago UK 1224 - ScanSource Imago FR 1234 - ScanSource Video Corp FR 1782 - ScanSource LA POS / Barcode 1784 - ScanSource LA Communications 5512 - ScanSource MX POS / Barcode 5514 - ScanSource MX Communications	string	None.
ContentType	application/json	string	None.
URL	Receivers end point	string	None.
Description	Description of web hook	string	None.
Active	Flag indicating if webhook is active	boolean	None.
Created	Created DateTime stamp	date	None.
Updated	Updated DateTime stamp	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "BusinessUnit": "sample string 4",
    "ContentType": "sample string 5",
    "URL": "sample string 6",
    "Description": "sample string 8",
    "Active": true,
    "Created": "2021-01-15T10:06:17.5755062-05:00",
    "Updated": "2021-01-15T10:06:17.5755062-05:00"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "BusinessUnit": "sample string 4",
    "ContentType": "sample string 5",
    "URL": "sample string 6",
    "Description": "sample string 8",
    "Active": true,
    "Created": "2021-01-15T10:06:17.5755062-05:00",
    "Updated": "2021-01-15T10:06:17.5755062-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfWebHook xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WebHook>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Identity>sample string 3</Identity>
    <BusinessUnit>sample string 4</BusinessUnit>
    <ContentType>sample string 5</ContentType>
    <URL>sample string 6</URL>
    <Secret>sample string 7</Secret>
    <Description>sample string 8</Description>
    <Active>true</Active>
    <AllowAllCustomers>true</AllowAllCustomers>
    <Created>2021-01-15T10:06:17.5755062-05:00</Created>
    <Updated>2021-01-15T10:06:17.5755062-05:00</Updated>
  </WebHook>
  <WebHook>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Identity>sample string 3</Identity>
    <BusinessUnit>sample string 4</BusinessUnit>
    <ContentType>sample string 5</ContentType>
    <URL>sample string 6</URL>
    <Secret>sample string 7</Secret>
    <Description>sample string 8</Description>
    <Active>true</Active>
    <AllowAllCustomers>true</AllowAllCustomers>
    <Created>2021-01-15T10:06:17.5755062-05:00</Created>
    <Updated>2021-01-15T10:06:17.5755062-05:00</Updated>
  </WebHook>
</ArrayOfWebHook>