GET 3dCartWebAPI/v1/Webhooks


Get all Webhooks

Request Information

URI Parameters

NameDescriptionTypeAdditional information
limit

Maximum number of items that can be returned

integer

Default value is 10

offset

Starting point for the return data

integer

Default value is 1

name

Webhook name

string

Default value is

url

Webhook URL

string

Default value is

enabled

Webhook enabled flag

integer

Default value is -1

format

Webhook format (JSON | XML)

string

Default value is

datecreatedstart

Start date that the webhook was created (mm/dd/yyyy hh:mm:ss)

string

Default value is

datecreatedend

End date that the webhook was created (mm/dd/yyyy hh:mm:ss)

string

Default value is

dateupdatedstart

Start date that the webhook was updated last time (mm/dd/yyyy hh:mm:ss)

string

Default value is

dateupdatedend

End date that the webhook was updated last time (mm/dd/yyyy hh:mm:ss)

string

Default value is

countonly

Count the number of rows only

integer

Default value is 0

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/16/2019 22:54",
    "DateUpdated": "10/16/2019 22:54",
    "Format": "sample string 4",
    "Enabled": true
  },
  {
    "Id": 1,
    "Name": "sample string 1",
    "Url": "sample string 2",
    "EventType": 64,
    "DateCreated": "10/16/2019 22:54",
    "DateUpdated": "10/16/2019 22:54",
    "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-16T22:54:48.4805881-04:00</DateCreated>
    <DateUpdated>2019-10-16T22:54:48.4805881-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-16T22:54:48.4805881-04:00</DateCreated>
    <DateUpdated>2019-10-16T22:54:48.4805881-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>