Примеры Webhook для изменения атрибутов контакта

​

Что это такое

​

Перед началом работы

• Создайте публичный HTTPS-эндпоинт в своем приложении.
• Настройте эндпоинт Webhook YCloud для необходимых типов событий.
• Надежно сохраните секрет подписи эндпоинта.
• Обеспечьте идемпотентность обработки событий.

​

Как это работает

​

Запрос

​

Ответ

HTTP/1.1 200 OK

​

Пример изменения тегов (добавление тегов)

​

Запрос

{
  "id": "evt_1234567892",
  "type": "contact.attributes_changed",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactAttributesChanged": {
    "id": "1824266594102064128",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "changedAttributes": {
      "tags": {
        "oldValue": ["premium", "newsletter"],
        "newValue": ["premium", "newsletter", "vip"],
        "extra": [
          {
            "action": "ADDED",
            "id": "686dd294334be8606a5bf312",
            "value": "vip"
          }
        ]
      }
    }
  }
}

​

Ответ

HTTP/1.1 200 OK

​

Пояснение

​

Пример изменения тегов (удаление тегов)

​

Запрос

{
  "id": "evt_1234567893",
  "type": "contact.attributes_changed",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactAttributesChanged": {
    "id": "1824266594102064128",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "changedAttributes": {
      "tags": {
        "oldValue": ["premium", "newsletter", "vip"],
        "newValue": ["premium", "newsletter"],
        "extra": [
          {
            "action": "REMOVED",
            "id": "686dd294334be8606a5bf312",
            "value": "vip"
          }
        ]
      }
    }
  }
}

​

Ответ

HTTP/1.1 200 OK

​

Пояснение

​

Пример изменения

​

Запрос

{
  "id": "evt_1234567900",
  "type": "contact.attributes_changed",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "contactAttributesChanged": {
    "id": "1824266594102064128",
    "updateTime": "2024-01-01T12:00:00.000Z",
    "changedAttributes": {
      "waba_id": {
        "oldValue": "waba_old_123456",
        "newValue": "waba_new_789012",
        "extra": [
          {
            "action": "CHANGED"
          }
        ]
      }
    }
  }
}

​

Ответ

HTTP/1.1 200 OK

​

Пояснение

• Корректная структура: объект contactAttributesChanged содержит три обязательных поля: id, updateTime и changedAttributes.
• Измененные атрибуты: поле changedAttributes представляет собой объект, где каждый ключ — это имя атрибута, а значение — объект ContactAttributeChange.
• Конфигурация свойств события: при включении событий contact.attributes_changed необходимо настроить поле eventProperties в вашем эндпоинте Webhook, указав, какие атрибуты должны включаться в полезную нагрузку Webhook.
• Типы атрибутов: поля oldValue и newValue могут содержать различные типы данных:
  • String: текстовые значения
  • Number: числовые значения (целые или десятичные)
  • Boolean: логические значения (true/false)
  • Array: массивы строк
  • Object: сложные объекты с вложенными свойствами
  • Null: когда атрибут удален или сброшен
• Изменения тегов: для атрибутов тегов поле extra предоставляет подробную информацию о добавленных или удаленных тегах, включая их идентификаторы и значения.
• Значения Null: когда атрибут удаляется или ему присваивается значение null, поле newValue будет иметь значение null. При добавлении нового атрибута поле oldValue может быть null.
• Пользовательские атрибуты: пользовательские атрибуты включаются в объект changedAttributes точно так же, как и стандартные атрибуты, при этом в качестве имен атрибутов используются их пользовательские ключи.
• Обнаружение изменений: в объект changedAttributes включаются только те атрибуты, которые действительно изменились.
• Поле Extra: поле extra является необязательным и используется преимущественно при изменениях тегов для предоставления дополнительного контекста о выполненных действиях.