Вебхуки клиентов

Все изменения в клиентах могут отправлены вебхуком. Здесь приведены примеры тела запроса для каждого типа события, связанного с клиентами. Как и в остальных частях API, данные передаются в формате JSON.

Как и в случае c REST API, список полей в теле вебхука отличается для юрлиц и физлиц. В частности, для юрлиц присутствует поле organization_name, а для физлиц – поля first_name, last_name и middle_name.

Клиент создан

{
  "event_type": "client_created",
  "version": 1,
  "context": {
    "source": "web",
    "happened_at": "2015-01-19T21:02:04.617Z",
    "created_at": "2015-01-19T21:02:04.617Z",
    "user_uuid": "8ebd12cc-b2d9-407c-a4f4-5943263d54a4",
    "user_email": "jack@black",
    "device_uuid": null
  },
  "client": {
    "uuid": "07cf12b5-f2da-4a77-8065-11cac610ed84",
    "external_id": "423430387320568-acme",
    "name": "ACME Corporation",
    "organization": true,
    "organization_name": "ACME Corporation",
    "contacts": [
      {
        "name": "Pedro",
        "value": "(834) 362-5246",
        "type": "phone"
      }
    ],
    "site_address": {
      "formatted": "Passeig de Gràcia, 92, 08008 Barcelona, Spain",
      "entrance_no": "1",
      "apartment": null,
      "floor": "1",
      "description": "Entrance via Carrer de Procença",
      "geolocation": {
        "longitude": 37.6785237278356,
        "latitude": 55.7862807707096
      }
    }
  }
}

Клиент обновлен

{
  "event_type": "client_updated",
  "version": 3,
  "context": {
    "source": "web",
    "happened_at": "2015-01-20T21:02:04.617Z",
    "created_at": "2015-01-20T21:02:04.617Z",
    "user_uuid": "8ebd12cc-b2d9-407c-a4f4-5943263d54a4",
    "user_email": "jack@black",
    "device_uuid": null
  },
  "client": {
    "uuid": "07cf12b5-f2da-4a77-8065-11cac610ed84",
    "external_id": "423430387320568-acme",
    "name": "ACME Corporation edited",
    "organization": true,
    "organization_name": "ACME Corporation edited",
    "contacts": [],
    "site_address": {
      "formatted": "Passeig de Gràcia, 92, 08008 Barcelona, Spain",
      "entrance_no": "1",
      "apartment": null,
      "floor": "1",
      "description": "Entrance via Carrer de Procença",
      "geolocation": {
        "longitude": 37.6785237278356,
        "latitude": 55.7862807707096
      }
    },
    "previous": {
      "external_id": "423430387320568-acme",
      "name": "ACME Corporation",
      "organization": true,
      "organization_name": "ACME Corporation",
      "contacts": [
        {
          "name": "Pedro",
          "value": "(834) 362-5246",
          "type": "phone"
        }
      ],
      "site_address": {
        "formatted": "Passeig de Gràcia, 92, 08008 Barcelona, Spain",
        "entrance_no": "1",
        "apartment": null,
        "floor": "1",
        "description": "Entrance via Carrer de Procença",
        "geolocation": {
          "longitude": 37.6785237278356,
          "latitude": 55.7862807707096
        }
      }
    }
  }
}

Клиент удален

{
  "event_type": "client_removed",
  "context": {
    "source": "web",
    "happened_at": "2015-01-21T21:02:04.617Z",
    "created_at": "2015-01-21T21:02:04.617Z",
    "user_uuid": "8ebd12cc-b2d9-407c-a4f4-5943263d54a4",
    "user_email": "jack@black",
    "device_uuid": null
  },
  "version": 15,
  "client": {
    "uuid": "07cf12b5-f2da-4a77-8065-11cac610ed84",
    "external_id": "423430387320568-acme",
    "name": "ACME Corporation edited",
    "organization": true,
    "organization_name": "ACME Corporation edited",
    "contacts": [],
    "site_address": {
      "formatted": "Passeig de Gràcia, 92, 08008 Barcelona, Spain",
      "entrance_no": "1",
      "apartment": null,
      "floor": "1",
      "description": "Entrance via Carrer de Procença",
      "geolocation": {
        "longitude": 37.6785237278356,
        "latitude": 55.7862807707096
      }
    }
  }
}

См. также

Вебхуки