Skip to main content
POST
Create endpoints

Авторизации

Authorization
string
header
обязательно

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Заголовки

X-Tenant-Id
integer

Компания, в контексте которой выполняется запрос — её id из GET /v1/tenant/. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса.

Тело

url
string<uri>
обязательно
Maximum string length: 1024
name
string
Maximum string length: 255
method
enum<string>
  • POST - POST
  • PUT - PUT
  • PATCH - PATCH
Доступные опции:
POST,
PUT,
PATCH
modules
enum<string>[]
  • order - Аренды
  • product - Продукты
  • system - Система
Доступные опции:
order,
product,
system
events
enum<string>[]
  • order.created - Аренда создана
  • order.status_changed - Статус аренды изменён
  • order.price_changed - Сумма аренды изменена
  • order.inventory_changed - Состав аренды изменён
  • order.updated - Аренда изменена
  • order.deleted - Аренда удалена
  • product.created - Продукт создан
  • product.price_changed - Цена продукта изменена
  • product.published_changed - Публикация продукта изменена
  • product.tariff_changed - Тарифы продукта изменены
  • product.component_changed - Состав продукта изменён
  • product.updated - Продукт изменён
  • product.deleted - Продукт удалён
  • webhook.ping - Тестовое событие
Доступные опции:
order.created,
order.status_changed,
order.price_changed,
order.inventory_changed,
order.updated,
order.deleted,
product.created,
product.price_changed,
product.published_changed,
product.tariff_changed,
product.component_changed,
product.updated,
product.deleted,
webhook.ping
headers
any
timeout
integer
Требуемый диапазон: 1 <= x <= 30
max_retries
integer
Требуемый диапазон: 0 <= x <= 10
active
boolean

Ответ

201 - application/json
id
integer
обязательно
read-only
url
string<uri>
обязательно
Maximum string length: 1024
name
string
Maximum string length: 255
method
enum<string>
  • POST - POST
  • PUT - PUT
  • PATCH - PATCH
Доступные опции:
POST,
PUT,
PATCH
modules
enum<string>[]
  • order - Аренды
  • product - Продукты
  • system - Система
Доступные опции:
order,
product,
system
events
enum<string>[]
  • order.created - Аренда создана
  • order.status_changed - Статус аренды изменён
  • order.price_changed - Сумма аренды изменена
  • order.inventory_changed - Состав аренды изменён
  • order.updated - Аренда изменена
  • order.deleted - Аренда удалена
  • product.created - Продукт создан
  • product.price_changed - Цена продукта изменена
  • product.published_changed - Публикация продукта изменена
  • product.tariff_changed - Тарифы продукта изменены
  • product.component_changed - Состав продукта изменён
  • product.updated - Продукт изменён
  • product.deleted - Продукт удалён
  • webhook.ping - Тестовое событие
Доступные опции:
order.created,
order.status_changed,
order.price_changed,
order.inventory_changed,
order.updated,
order.deleted,
product.created,
product.price_changed,
product.published_changed,
product.tariff_changed,
product.component_changed,
product.updated,
product.deleted,
webhook.ping
headers
any
timeout
integer
Требуемый диапазон: 1 <= x <= 30
max_retries
integer
Требуемый диапазон: 0 <= x <= 10
active
boolean