GET 3dCartWebAPI/v1/Webhooks/{id}


Get a Webhook

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id

integer

Required

Body Parameters

None.


Sample Request



Response Information

Resource Description

Collection of Webhook
NameDescriptionTypeAdditional information
Id

database reference = webhooks.id

integer

None.

Name

database reference = webhooks.name

string

String length: inclusive between 0 and 80

Url

database reference = webhooks.url

string

String length: inclusive between 0 and 1000

EventType

database reference = webhooks.event_type

byte

None.

DateCreated

database reference = webhooks.datecreated

date

None.

DateUpdated

database reference = webhooks.dateupdated

date

None.

Format

(JSON | XML) database reference = webhook_formats.format_name

string

String length: inclusive between 0 and 50

Enabled

database reference = webhooks.enabled

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 1",
    "Url": "sample string 2",
    "EventType": 64,
    "DateCreated": "10/18/2019 06:45",
    "DateUpdated": "10/18/2019 06:45",
    "Format": "sample string 4",
    "Enabled": true
  },
  {
    "Id": 1,
    "Name": "sample string 1",
    "Url": "sample string 2",
    "EventType": 64,
    "DateCreated": "10/18/2019 06:45",
    "DateUpdated": "10/18/2019 06:45",
    "Format": "sample string 4",
    "Enabled": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfWebhook xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Webhook>
    <DateCreated>2019-10-18T06:45:25.2855229-04:00</DateCreated>
    <DateUpdated>2019-10-18T06:45:25.2855229-04:00</DateUpdated>
    <Enabled>true</Enabled>
    <EventType>64</EventType>
    <Format>sample string 4</Format>
    <Id>1</Id>
    <Name>sample string 1</Name>
    <Url>sample string 2</Url>
  </Webhook>
  <Webhook>
    <DateCreated>2019-10-18T06:45:25.2855229-04:00</DateCreated>
    <DateUpdated>2019-10-18T06:45:25.2855229-04:00</DateUpdated>
    <Enabled>true</Enabled>
    <EventType>64</EventType>
    <Format>sample string 4</Format>
    <Id>1</Id>
    <Name>sample string 1</Name>
    <Url>sample string 2</Url>
  </Webhook>
</ArrayOfWebhook>