Проверка создания карточки в доп.воронке

В настройках каждой дополнительной воронки вы можете указать два webhookа и реализовать свою проверку на создание карточек и на изменение этапа карточки.

Вебхуки отправляются в момент выполнения действия и передают базовую информацию о совершенном пользователем действии. Вы получаете эту информацию, и на основе нее, пользуясь нашим API, отвечаете на каждый вебхук либо успехом, либо ошибкой.

На экране пользователя появляется загрузка ответа от вашей системы.
Это значит, что ответ должен быть максимально оперативным. 

Проверка в момент создания

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

Интерфейс ручного создания карточки в доп.воронках из клиента

Если поле "Webhook перед созданием" внутри настроек доп.воронки, в которой хотят создать новую карточку, заполнено, то сразу же в момент создания карточки мы отправляем POST запрос на указанный адрес.

Расположение данного вебхука в настройках воронки

В теле запроса отправляем json-объект:

{
	// ID дополнительной воронки
	"funnel_id": 123

	// ID пользователя из ДП, который создает карточку
	"user_id": 345

	// родительская сущность, из которой вызывается создание карточки
	// 1 = клиент, 2 = сделка, более 100 = ID дополнительной воронки
	"parent_store": 1

	// ID объекта родительской сущности, 1 - ID клиента, 2 - ID сделки
	// более 100 – ID карточки в доп воронке. Тесно связан со "store"
	"parent_object_id": 1234
}

В ответ ждем json-объект в двух вариациях:

1) успех создания – тогда Домопланер создаст карточку и переведет пользователя в новую созданную карточку. Мы ждем от вас в вебхуке:

{
	"success": true
}

2) создание запрещено – тогда пользователю внутри интерфейса выведется предупреждение, что создание невозможно. Мы ждем от вас в вебхуке:

{
	"error": true,
	"error_text": "Карточка с такой связью уже есть, перейдите в нее",
	
	// передайте дополнительный параметр link, тогда в предупреждении
	// появится кнопка "Перейти", которая будет открывать указанную ссылку
	"link": "https://domoplaner.ru/xxxxx"
}

Проверка в момент смены этапа

Вебхук вызывается каждый раз, когда внутри Домопланера пользователь изменяет этап карточки дополнительной воронки.

Если поле "Webhook при смене этапа" внутри настроек доп.воронки, в которой хотят сменить этап карточки, заполнено, то сразу же перед сменой этапа Домопланер отправляет POST запрос на указанный адрес.

Расположение данного вебхука в настройках воронки

В теле запроса отправляем json-объект:

{
	// ID дополнительной воронки
	"funnel_id": 123
      
	// ID карточки из доп.воронки
	"card_id": 12345

	// ID пользователя из ДП, который меняет этап
	"user_id": 345
  
	// ID этапа, в который передвигается карточка
	"status_id": 546

	// ID подэтапа, в который передвигается карточка
	"substatus_id": 95854 или null
}

В ответ ждем json-объект в двух вариациях:

1) успех перевода – тогда Домопланер перевед карточку на указанный пользователем этап. Мы ждем от вас в вебхуке:

{
	"success": true
}

2) создание запрещено – тогда пользователю внутри интерфейса выведется предупреждение, что перевод невозможен. Мы ждем от вас в вебхуке:

{
	"error": true,
	"error_text": "Перевести нельзя, потому что...",
	
	// передайте дополнительный параметр link, тогда в предупреждении
	// появится кнопка "Перейти", которая будет открывать указанную ссылку
	"link": "https://domoplaner.ru/xxxxx"
}