Webhook — Eventos de instalação

Para consumir eventos do processo de instalação via webhook, o parceiro deve estar cadastrado junto aos sistemas da companhia. O cadastro é feito internamente por meio das informações de cnpj, nome do parceiro, chave de autenticação e url de retorno de chamada. O documento abaixo, tem como objetivo apresentar os eventos que podem ser emitidos e as informações contidas nos mesmos. As informações apresentadas a seguir são encaminhadas no corpo da chamada HTTP POST para a URL de retorno de chamada disponibilizada pelo parceiro.

Estrutura de dados

Abaixo são apresentados os formatos e tamanhos dos atributos dos objetos que compõem os eventos.

TABELA (A Definir)

-----------------------------

Exemplos de eventos
Instalação solicitada
text
{ "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_REQUESTED", "schemaVersion":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "order_number": "MXD54S433", "type": "INSTALLATION", "activity": "INSTALLATION", "request": { "type": "", "subtype": "" }, "priority": "IMMEDIATE_DELIVERY", "sla": { "ec": "2025-12-27T12:00:00.000Z", "eps": "2025-12-27T12:00:00.000Z" }, "status": "CREATED", "details": "...", "accreditation_channel": "", "customer": { "id": "34556721", "cpf_cnpj": "76435275000110", "name": "EMPRESA DE TESTE", "address": { "cep":"96780000", "street": "Avenida Alceu Rossi", "number": "277", "complement": "AP 179", "reference": "Torre Leste", "district": "Centro", "city": "Paranaíta", "state": "MT" }, "phones": [ "51996557302" ], "workday": [ { "week_day": "MONDAY", "start": "08:00", "end": "12:00" }, { "week_day": "MONDAY", "start": "13:00", "end": "18:00" }, { "week_day": "TUESDAY", "start": "08:00", "end": "18:00" }, { "week_day": "WEDNESDAY", "start": "08:00", "end": "18:00" }, { "week_day": "THURSDAY", "start": "08:00", "end": "18:00" }, { "week_day": "FRIDAY", "start": "08:00", "end": "18:00" } ] }, "service_agent": { "provider": { "cnpj": "94081271000162" }, "technician": { "cpf": "40256529000" }, "work_center": { "id": "CT000123", "name": "Mobian" } }, "equipment": { "capture_method": "", "technology": "", "best_equipment": { "sku": "", "skuDescription": "", "condition": "GOOD", "charger": true } }, "chip": { "chip1": "", "chip2": "", "customer": "" }, "coil": { "kitSku": "", "kitQuantity": 2, "total": 10 } }
Instalação alterada
text
{ "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CHANGED", "order_number": "MXD54S433", "schema_version":"1", "producer": "erp-field-service-ms", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "ocurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "service_agent": { "provider": { "cnpj": "94081271000162" }, "technician": { "cpf": "40256529000" }, "work_center": { "id": "CT000123", "name": "Mobian" } }, "priority": "IMMEDIATE_DELIVERY", "sla": { "ec": "2025-12-27 12:00:00", "eps": "2025-12-27 12:00:00" } }

*Obs.: Em casos onde houver a mudança de prioridade do sistema operacional, a mesma pode ser encaminhada para outro parceiro. De modo que a carga útil do evento poderá ser retornada conforme abaixo:

text
{ "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CHANGED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "priority": "NORMAL", "details": "A ordem de serviço foi encaminhada para outro operador logístico." }
Instalação cancelada
text
"metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CANCELED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "status":"CANCELED", "canceled_at": "2025-12-27T11:23:54", "cancel_reason": { "id": "", "description": "" } } }
Falha na instalação
text
{ "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_FAILED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "status": "FAILED", "failed_at": "2025-12-27T12:00:00", "failed_reason": { "macro": { "code":"", "description":"" }, "micro": { "code":"", "description":"" } } }
Instalação concluída
text
{ "metadata": { "event_id": "b46ee43a-246a-48cb-bcad-e6799b61f83d", "event_type": "INSTALLATION_CONCLUDED", "schema_version":"1", "producer": "erp-field-service-ms", "order_number": "MXD54S433", "work_order_id": "bb2d7a60-0e88-4ca5-98c8-7aedc2098703", "work_order_number": "43214567", "occurred_at": "2025-12-27T10:00:00.000Z" }, "payload": { "status": "CONCLUDED", "equipment": { "installed": { "serial":"", "sku": "" } },