Notify API сервера task24.pro

API позволяет получать оповещения с сервера task24  на заданные URL: оповещение по изменению данных

Уведомления разделяются на следующие виды:

  • Общее уведомление по любым изменениям объекта. Инициируется при любых изменениях объекта: создан, изменен, удален
  • Уведомление по изменению состояния объекта (state). Инициируется только в случае, когда сменилось состояние объекта. Например, для заявок можно получить уведомление, когда она поступила, взята на исполнение, выполнилась и т.п.

Реализован в виде Callback-механизма: на ваш URL будут отправляться уведомления следующей структуры:

Структура данных уведомлений API

Все данные приходят в JSON-формате, следующего вида:

{
	action:	"create" | "update" | "delete"
		Действие с объектом (соответственно, "создан" | "изменен" | "удален")
	type: "ticket"
		Тип измененного объекта системы
	[state]: для объектов с состоянием, содержит последнее состояние объекта
		Для подробностей смотрите Data API для того или иного объекта
	data: {} - содержит структуру полей объекта
		в виде {“поле”: “значение”}
}

Пример уведомления для Tickets:

	{
		"action": "update",
		"type": "ticket",
		"state": "completed", //Заявка выполнена
		"data": {
			//Данные заявки
		}
	}

Настройка уведомлений в системе

Для настройки соответствующие URL указываются в параметрах личного кабинета, в разделе Интеграция.