POST webhooks

Subscribe to webhook to start receiving event notifications

Request Information

URI Parameters

None.

Body Parameters

Webhook

WebHookModel
NameDescriptionTypeAdditional information
Id

Id webhook used to update / delete

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

Required

WebHookURL

Your end point to receive webhook callback when event happens

string

Required

Max length: 200

Secret

Your secret - sent with callback

string

None.

Description

Description of webhook

string

Required

Active

Flag indicating webhook is active

boolean

Required

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 1",
  "BusinessUnit": "sample string 2",
  "ContentType": "sample string 3",
  "WebHookURL": "sample string 4",
  "Secret": "sample string 5",
  "Description": "sample string 6",
  "Active": true
}

application/xml, text/xml

Sample:
<WebHookModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <Name>sample string 1</Name>
  <BusinessUnit>sample string 2</BusinessUnit>
  <ContentType>sample string 3</ContentType>
  <WebHookURL>sample string 4</WebHookURL>
  <Secret>sample string 5</Secret>
  <Description>sample string 6</Description>
  <Active>true</Active>
</WebHookModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WebHookModel'.

Response Information

Resource Description

WebHook
NameDescriptionTypeAdditional 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-05-13T18:57:02.0053979-04:00",
  "Updated": "2021-05-13T18:57:02.0053979-04:00"
}

application/xml, text/xml

Sample:
<WebHook xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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-05-13T18:57:02.0053979-04:00</Created>
  <Updated>2021-05-13T18:57:02.0053979-04:00</Updated>
</WebHook>