GET api/v1/application/{applicationID}/store/{storeID}/webhook/{webhookID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
applicationID

string

Required

storeID

string

Required

webhookID

string

Required

Body Parameters

None.

Response Information

Resource Description

WebhookResponse
NameDescriptionTypeAdditional information
LastNotify

date

None.

LastError

date

None.

ConcurrentErrorCount

integer

None.

CreatedByID

integer

None.

UpdatedByID

integer

None.

Created

date

None.

Updated

date

None.

ID

string

None.

ApplicationID

string

None.

StoreID

string

None.

Secret

string

None.

Type

WebhookType

None.

Description

string

None.

HttpMethod

string

None.

IncludePayload

boolean

None.

URL

string

None.

Enabled

boolean

None.

DisabledReason

string

None.

DisableFailureThreashold

integer

None.

WarningFailureThreashold

integer

None.

RetryDelay

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "LastNotify": "2024-12-04T08:39:26.8520749+00:00",
  "LastError": "2024-12-04T08:39:26.8520749+00:00",
  "ConcurrentErrorCount": 1,
  "CreatedByID": 2,
  "UpdatedByID": 1,
  "Created": "2024-12-04T08:39:26.8520749+00:00",
  "Updated": "2024-12-04T08:39:26.8520749+00:00",
  "ID": "sample string 5",
  "ApplicationID": "sample string 6",
  "StoreID": "sample string 7",
  "Secret": "sample string 8",
  "Type": 0,
  "Description": "sample string 9",
  "HttpMethod": "sample string 10",
  "IncludePayload": true,
  "URL": "sample string 11",
  "Enabled": true,
  "DisabledReason": "sample string 12",
  "DisableFailureThreashold": 1,
  "WarningFailureThreashold": 1,
  "RetryDelay": 1
}

application/xml, text/xml

Sample:
<WebhookResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response">
  <ApplicationID xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">sample string 6</ApplicationID>
  <Description xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">sample string 9</Description>
  <DisableFailureThreashold xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">1</DisableFailureThreashold>
  <DisabledReason xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">sample string 12</DisabledReason>
  <Enabled xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">true</Enabled>
  <HttpMethod xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">sample string 10</HttpMethod>
  <ID xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">sample string 5</ID>
  <IncludePayload xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">true</IncludePayload>
  <RetryDelay xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">1</RetryDelay>
  <Secret xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">sample string 8</Secret>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">sample string 7</StoreID>
  <Type xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">ProductChange</Type>
  <URL xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">sample string 11</URL>
  <WarningFailureThreashold xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Common">1</WarningFailureThreashold>
  <ConcurrentErrorCount>1</ConcurrentErrorCount>
  <Created>2024-12-04T08:39:26.8520749+00:00</Created>
  <CreatedByID>2</CreatedByID>
  <LastError>2024-12-04T08:39:26.8520749+00:00</LastError>
  <LastNotify>2024-12-04T08:39:26.8520749+00:00</LastNotify>
  <Updated>2024-12-04T08:39:26.8520749+00:00</Updated>
  <UpdatedByID>1</UpdatedByID>
</WebhookResponse>

multipart/form-data

Sample:

An exception has occurred while using the formatter 'MultiPartMediaFormat' to generate sample for media type 'multipart/form-data'. Exception message: The media type formatter of type 'MultiPartMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/png

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/png'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/jpeg

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/jpeg'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.

image/bmp

Sample:

An exception has occurred while using the formatter 'ImageMediaFormat' to generate sample for media type 'image/bmp'. Exception message: The media type formatter of type 'ImageMediaFormat' does not support writing because it does not implement the WriteToStreamAsync method.