Настройки

Чтобы настроить webhook, необходимо указать URL-адрес на который будут отправляться уведомления, выбрать нужные события и данные которые будут передаваться.

Все уведомления передаются в формате JSON и содержат поля eventId, action и data.

• В поле action передаётся информация о наступившем событии (его тип, название и идентификаторы).

• В поле data содержатся выбранные в настройках данные, относящиеся к событию.

• Поле eventId является уникальным идентификатором конкретного события в системе. Для каждого отдельного события (например, каждого создания заказа) значение этого поля будет уникальным. Оно остаётся неизменным только при повторной отправке одного и того же уведомления.

{
  eventId: <уникальный id конкретного события>,
  action: {
    id: <id типа события>,
    groupId: <id webhook>,
    name: <название события>
  },
  data: {
    ...
  }
}

Поле data настраивается для каждого события отдельно:

Настройка передаваемых данных

Дополнительно для webhook можно добавить собственные заголовки. Эти заголовки будут добавляться в каждое уведомление:

Настройка заголовков