Подписка на события

Создаёт подписку на создание/изменение заказов.

Обязательные параметры запроса:

{
    controller: 'webhook'
    action: 'subscribe',
    handler: string,
    sig: <api_key>,
}

Ответ сервера:

{
    id: number, // id нового хендлера
    code: <ResponseCodes>
}

Формат уведомлений (метод POST):

1) Создание (такси):

{
    type: 'create',
    order_type: 'taxi'
    order: {
        id: number,
        client_id: number,
        deffered_trip: '%Y-%m-%d %H:%m:%s' | null,
        phone: '7xxxxxxxxxx',
        src_address: string,
        dst_address: string,
        status: <OrderStatus>,
        type: <OrderType>,
        price: number,
        estimate_price: number,
        source: <OrderSource>,
        created: '%Y-%m-%d %H:%m:%s',
        landing_id: string | null // Для заказов такси
    }
}

1.1) Создание (доставка):

{
    type: 'create',
    order_type: 'delivery'
    order: <DeliveryOrder>
}

2) Изменение:

{
    type: 'update',
    order: { ... те же поля, что и при создании },
    changedFields: [ 'status', 'estimate_price' ]
}

Типы: ResponseCodes, OrderStatus, OrderType, OrderSource, DeliveryOrder

Пример использования:

var xhr = new XMLHttpRequest();
var formData = new FormData();
xhr.open('POST', 'https://admin-api.calltovisit.com', true);
formData.append('controller', 'webhook');
formData.append('action', 'subscribe');
formData.append('handler', 'http://example.com');
formData.append('sig', 'FmYHRjgnoHAckbgk5bA4VHQZCcAlVYfM');
xhr.send(formData);

results matching ""

    No results matching ""