GET 3dCartWebAPI/v1/Webhooks?limit={limit}&offset={offset}&name={name}&url={url}&enabled={enabled}&format={format}&datecreatedstart={datecreatedstart}&datecreatedend={datecreatedend}&dateupdatedstart={dateupdatedstart}&dateupdatedend={dateupdatedend}&countonly={countonly}

GET 3dCartWebAPI/v1/Webhooks

Get all Webhooks

Request Information

URI Parameters

Name	Description	Type	Additional 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

PHP

Python

Ruby

Response Information

Resource Description

Collection of Webhook

Name	Description	Type	Additional 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	integer	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": 3,
    "DateCreated": "04/18/2024 18:44",
    "DateUpdated": "04/18/2024 18:44",
    "Format": "sample string 4",
    "Enabled": true
  },
  {
    "Id": 1,
    "Name": "sample string 1",
    "Url": "sample string 2",
    "EventType": 3,
    "DateCreated": "04/18/2024 18:44",
    "DateUpdated": "04/18/2024 18:44",
    "Format": "sample string 4",
    "Enabled": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfWebhook xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Webhook>
    <Id>1</Id>
    <Name>sample string 1</Name>
    <Url>sample string 2</Url>
    <EventType>3</EventType>
    <DateCreated>2024-04-18T18:44:41.1912784-04:00</DateCreated>
    <DateUpdated>2024-04-18T18:44:41.1912784-04:00</DateUpdated>
    <Format>sample string 4</Format>
    <Enabled>true</Enabled>
  </Webhook>
  <Webhook>
    <Id>1</Id>
    <Name>sample string 1</Name>
    <Url>sample string 2</Url>
    <EventType>3</EventType>
    <DateCreated>2024-04-18T18:44:41.1912784-04:00</DateCreated>
    <DateUpdated>2024-04-18T18:44:41.1912784-04:00</DateUpdated>
    <Format>sample string 4</Format>
    <Enabled>true</Enabled>
  </Webhook>
</ArrayOfWebhook>