POST 3dCartWebAPI/v1/Webhooks

Adds a new Webhook to the system

Request Information

URI Parameters

None.

Body Parameters

A Json or XML object containing the new Webhook

Name	Description	Type	Additional information
Name	database reference = webhooks.name	string	Required String length: inclusive between 0 and 80
Url	database reference = webhooks.url	string	Required String length: inclusive between 0 and 1000
EventType	database reference = webhooks.event_type	integer	Required
Format	(JSON \| XML) database reference = webhook_formats.format_name	string	String length: inclusive between 0 and 50
Enabled	database reference = webhooks.enabled	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Url": "sample string 2",
  "EventType": 3,
  "Format": "sample string 4",
  "Enabled": true
}

application/xml, text/xml

Sample:

<WebhookPOST xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>sample string 1</Name>
  <Url>sample string 2</Url>
  <EventType>3</EventType>
  <Format>sample string 4</Format>
  <Enabled>true</Enabled>
</WebhookPOST>

Sample Request

PHP

Python

Ruby

Response Information

application/json, text/json

Sample:

[
    {
    "Key":"Id",
    "Value":"1234",
    "Status":"201",
    "Message":"Created successfully",
    }
]

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.