Запрос:
GET /admin/webhooks.xml
Ответ:
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<webhooks type="array">
<webhook>
<id type="integer">830</id>
<address>http://application.ru/orders/create</address>
<created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
<topic>orders/create</topic>
</webhook>
<webhook>
<id type="integer">831</id>
<address>http://application.ru/orders/create</address>
<created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
<topic>orders/update</topic>
</webhook>
</webhooks>
Запрос:
GET /admin/webhooks/#{id}.xmlОтвет:
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<webhook>
<id type="integer">831</id>
<address>http://application.ru/orders/create</address>
<created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
<topic>orders/update</topic>
</webhook>
Доступны значения для topic orders/create, orders/update, client/create и client/update.
Запрос:
POST /admin/webhooks.xml
<webhook>
<address>http://application.ru/orders/update</address>
<topic>orders/update</topic>
</webhook>
Ответ:
HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<webhook>
<id type="integer">831</id>
<address>http://application.ru/orders/create</address>
<created-at type="datetime">2010-07-29T18:17:45+04:00</created-at>
<topic>orders/update</topic>
</webhook>
Доступны значения orders/create, orders/update, products/create, products/update.
Для webhooks с топиками products/create, products/update данные отправляются группами по несколько продуктов сразу, количеством получаемых продуктов в одном ответе от вебхука можно управлять с помощью поля batch_size.
Если поле не указано, то по умолчанию за значение будет принято 10.
Запрос XML:
POST /admin/webhooks.xml
<webhook>
<address>http://application.ru/orders/update</address>
<topic>products/create</topic>
<batch-size>10</batch-size>
</webhook>
Запрос JSON:
{
"webhook": {
"address": "http://application.ru/orders/update",
"topic": "products/create",
"batch_size": 10
}
}Доступно для топика products/update.
Для указания канала продаж, по которому будут отслеживаться создание или изменение products используется поле sales_channel_id. В нем указывается уникальный ID канала продаж.
При его указании в вебхуке будут отправляться только те products, которые связаны с указанным каналом продаж.
Запрос XML:
POST /admin/webhooks.xml
<webhook>
<address>http://application.ru/orders/update</address>
<topic>products/update</topic>
<batch-size>10</batch-size>
<sales-channel-id>10</sales-channel-id>
</webhook>
Запрос JSON:
{
"webhook": {
"address": "http://application.ru/orders/update",
"topic": "products/update",
"batch_size": 10,
"sales_channel_id": 10
}
}Запрос:
DELETE /admin/webhooks/#{id}.xmlОтвет:
HTTP/1.1 200 OK
Доступно для топиков orders/create,orders/update, orders/destroy.
Запрос XML:
POST /admin/webhooks.xml
<webhook>
<address>http://application.ru/orders/update</address>
<topic>orders/update</topic>
<warehouse-id>117</warehouse-id>
</webhook>
Запрос JSON:
{
"webhook": {
"address": "http://application.ru/orders/update",
"topic": "orders/update",
"warehouse_id": 117
}
}Для указания канала продаж, по которому будут отслеживаться изменения products, используется поле sales_channel_id. В нем указывается уникальный ID канала продаж (только для топика products/update).
Запрос XML:
POST /admin/webhooks.xml
<webhook>
<address>http://application.ru/products/update</address>
<topic>products/update</topic>
<batch-size>10</batch-size>
<sales-channel-id>10</sales-channel-id>
</webhook>
Запрос JSON:
{
"webhook": {
"address": "http://application.ru/products/update",
"topic": "products/update",
"batch_size": 10,
"sales_channel_id": 10
}
}
