Webhook eventos de Instalação
| Data | Versão | Revisor |
|---|---|---|
| 26/01/2026 | 1.0.0 | William dos Reis Freitas<william.freitas@pagonxt.com > |
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 através das informações de cnpj, nome do parceiro, chave de autenticação e url de callback.
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 de chamada HTTP POST para a URL de callback disponibilizada pelo parceiro.
Estrutura de Dados
Abaixo são apresentados os formatos e tamanhos dos atributos dos objetos que compõem os eventos.
| Metadata | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| event_id | string | 36 | ||
| event_type | enum | EventTypeEnum | ||
| schemaVersion | string | 8 | ||
| producer | string | |||
| order_number | string | 30 | ||
| work_order_id | string | 36 | ||
| work_order_number | string | 12 | ||
| ocurred_at | string | 22 | YYYY-MM-DDThh:mm:ssTZD |
| Payload | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| id | string | 36 | ||
| work_order_number | string | 12 | ||
| order_number | string | 30 | ||
| type | enum | WorkOrderTypeEnum | ||
| activity | enum | WorkOrderActivityEnum | ||
| request | object | Request | ||
| priority | enum | WorkOrderPriorityEnum | ||
| sla | object | WorkOrderSLA | ||
| status | enum | WorkOrderStatusEnum | ||
| details | string | 40 | ||
| accreditation_channel | string | 40 | ||
| customer | object | Customer | ||
| service_agent | object | ServiceAgent | ||
| equipment | object | Equipment | ||
| chip | object | Chip | ||
| coil | object | Coil |
| Request | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| type | string | 40 | ||
| subtype | string | 40 |
| WorkOrderSLA | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| ec | string | 22 | YYYY-MM-DDThh:mm:ssTZD | |
| eps | string | 22 | YYYY-MM-DDThh:mm:ssTZD |
| Customer | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| id | string | 36 | ||
| cpf_cnpj | string | 14 | ||
| name | string | 35 | ||
| address | object | Address | ||
| phones | array (string) | |||
| workday | array (object) | WorkDay |
| Address | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| cep | string | 10 | ||
| street | string | 60 | ||
| number | string | 10 | ||
| complement | string | 10 | ||
| reference | string | 40 | ||
| district | string | 40 | ||
| city | string | 40 | ||
| state | string | 3 |
| WorkDay | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| week_day | enum | WeekDayEnum | ||
| start | string | 5 | HH:mm | |
| end | string | 5 | HH:mm |
| ServiceAgent | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| provider | object | ServiceAgentProvider | ||
| technician | object | ServiceAgentTechnician | ||
| work_center | object | ServiceAgentWorkCenter |
| ServiceAgentProvider | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| cnpj | string | 16 |
| ServiceAgentTechnician | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| cpf | string | 12 |
| ServiceAgentWorkCenter | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| id | string | 8 | ||
| name | string |
| Equipment | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| capture_method | string | 30 | ||
| technology | string | 50 | ||
| best_equipment | object | BestEquipment |
| BestEquipment | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| sku | string | 18 | ||
| skuDescription | string | 40 | ||
| condition | enum | EquipmentConditionEnum | ||
| charger | boolean |
| Chip | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| chip1 | string | 10 | ||
| chip2 | string | 10 | ||
| customer | string | 10 |
| Coil | ||||
|---|---|---|---|---|
| Atributo | Tipo | Tam. | Formato | Referência |
| kitSku | string | 18 | ||
| kitQuantity | int | |||
| total | int |
Valores dos Enums
Abaixo seguem os valores possíveis para os enumeradores mencionados.
| Enums | |
|---|---|
| Enum | Valor |
| EventTypeEnum | INSTALLATION_REQUESTED |
| EventTypeEnum | INSTALLATION_CHANGED |
| EventTypeEnum | INSTALLATION_CANCELED |
| EventTypeEnum | INSTALLATION_FAILED |
| EventTypeEnum | INSTALLATION_CONCLUDED |
| WorkOrderTypeEnum | INSTALLATION |
| WorkOrderActivityEnum | INSTALLATION |
| WorkOrderActivityEnum | ADDITIONAL_INSTALLATION |
| WorkOrderActivityEnum | PILOT |
| WorkOrderActivityEnum | DEPLOYMENT_INSTALL |
| WorkOrderPriorityEnum | IMMEDIATE_DELIVERY |
| WorkOrderStatusEnum | IN_PROGRESS |
| WorkOrderStatusEnum | SUCCESSED |
| WorkOrderStatusEnum | FAILED |
| WorkOrderStatusEnum | CANCELED |
| EquipmentConditionEnum | GOOD |
| EquipmentConditionEnum | NEW_GOOD |
Exemplos de Eventos
InstallationRequested
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
}
}
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
}
}
InstallationChanged
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"
}
}
}
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 da OS, a mesma pode ser encaminhada para outro parceiro. De modo que o payload do evento poderá ser retornado 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."
}
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."
}
InstallationCanceled
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": ""
}
}
}
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": ""
}
}
}
InstallationFailed
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":""
}
}
}
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":""
}
}
}
InstallationConcluded
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": ""
}
},
"concluded_at":"2025-12-27T16:45:10"
}
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": ""
}
},
"concluded_at":"2025-12-27T16:45:10"
}