CreateWebhook

post

https://sellercenter-api.linio.com.mx/?Action=CreateWebhook

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Request payload
The body transmitted by the POST is an XML structure.

Request Body

<?xml version="1.0" encoding="UTF-8" ?>
<Request>
	<Webhook>
		<CallbackUrl>http://example.com/callback</CallbackUrl>
    <Events>
      <Event>onOrderCreated</Event>
      <Event>onProductCreated</Event>
    </Events>
	</Webhook>
</Request>

The XML tags have the following meaning:

Field name	Type	Comment
CallbackUrl	String	The Webhook url that will be called by Seller Center.
Events	Event[]	List of webhook related events identified by its alias, see GetWebhookEntities call for more details.

Error description

Error Code	Error Description
5	Invalid Request Format
6	Unexpected internal error (may mean feature is not configured or unknown error occurred)
89	Required field is missing
98	Invalid Webhook Callback Url, "Given url is invalid."
99	Invalid Webhook Event Alias, "Events alias are not matching

Example of Error Response

<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse>
     <Head>
       <RequestAction>CreateWebhook</RequestAction>
       <ErrorType>Sender</ErrorType>
       <ErrorCode>96</ErrorCode>
       <ErrorMessage>
         E096: Invalid Webhook Event Alias, "Events alias are not matching"
       </ErrorMessage>
     </Head>
     <Body/>
</ErrorResponse>

Query Params

Action

string

required

Defaults to CreateWebhook

Name of the function that is to be called. Mandatory and must be 'CreateWebhook' in this case. If omitted, an 'E001: Parameter Action is mandatory' error is returned. If an unknown function string is supplied, an 'E008: Invalid Action' error message is returned.

Timestamp

date

required

The current time in ISO8601 format relative to UTC (e.g., Timestamp=2015-04-01T10:00:00+02:00 for Berlin), so that calls cannot be replayed by an eaves-dropping third party (i.e., those calls too far into the past or future yield an error message). Mandatory. If not supplied, an 'E001: Parameter Timestamp is mandatory' error message results. If the timestamp is too old or in the future, an 'E003: Timestamp has expired' error message is returned.

Version

string

required

The API version against which this call is to be executed, in major-dot-minor format. Must currently be 1.0, even though the actual version of the API is 2.6.20. If omitted, an ‘E001: Parameter Version is mandatory’ error message is returned.

Signature

string

required

The cryptographic signature, authenticating the request. A caller must create this value by computing the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Mandatory. If omitted, an ‘E001: Parameter Signature is mandatory’ error message is returned. If the signature is incorrect, an ‘E007: Login failed. Signature mismatch’ error message is returned.

Format

string

Defaults to XML

If supplied, must be either 'JSON' or 'XML'. If not supplied, 'XML' is assumed.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Request payload

Request Body

Error description

Example of Error Response

200200