Webhooks

Webhooks avisam o seu sistema, em tempo real, quando algo acontece na operação: uma ordem criada, uma atividade concluída, um formulário respondido. Em vez de consultar a API de tempos em tempos, você recebe uma requisição POST na URL que cadastrar.

Eventos

Evento	Quando é enviado
order-created	Ordem de serviço criada
order-updated	Ordem de serviço atualizada
order-form-created	Formulário criado na ordem
order-form-updated	Formulário da ordem atualizado
order-attachment-created	Anexo criado
order-attachment-updated	Anexo atualizado
order-attachment-deleted	Anexo excluído
task-created	Atividade criada
task-updated	Atividade atualizada
task-start-route	Colaborador iniciou o deslocamento para a atividade
task-route-started	Rota da atividade iniciada
task-started	Atividade iniciada pelo colaborador
task-completed	Atividade concluída
task-reported	Impedimento registrado na atividade
task-rated	Atividade avaliada pelo cliente
comment-created	Comentário criado
employee-created	Colaborador criado
ticket-created	Solicitação de serviço criada
ticket-accepted	Solicitação de serviço aceita
ticket-canceled	Solicitação de serviço cancelada
ticket-closed	Solicitação de serviço encerrada
ticket-expired	Solicitação de serviço expirada
ticket-refused	Solicitação de serviço recusada
quotation-created	Orçamento criado
quotation-updated	Orçamento atualizado
quotation-approved	Orçamento aprovado
quotation-canceled	Orçamento cancelado
quotation-refused	Orçamento recusado
vehicle-created	Veículo criado
vehicle-updated	Veículo atualizado

O corpo da requisição é o recurso do evento, no mesmo formato da API: em task-created vem uma atividade, em comment-created um comentário, e assim por diante.

Headers enviados

Header	Conteúdo
X-FieldControl-Event	Nome do evento
X-FieldControl-Delivery	Identificador único do envio
X-FieldControl-Account	Identificador da conta
User-Agent	FieldControl-Hookshot/<identificador do envio>
Content-Type	Sempre application/json

Se a URL foi cadastrada com autenticação, o envio usa autenticação HTTP Basic com o usuário e a senha informados.

Como tratar um evento

1. Confira em X-FieldControl-Delivery se o envio já foi processado, para não processar o mesmo evento duas vezes.
2. Leia o evento em X-FieldControl-Event.
3. Atualize o seu sistema com o corpo recebido.
4. Responda rápido: o Field Control espera a resposta por até 15 segundos. Faça o processamento pesado depois de responder.

Cadastrar a URL

1. No Painel do Gestor, abra Configurações > API de integração e, na seção Webhooks da integração, clique em Novo Webhook.

   

2. Informe a URL e a autenticação (sem autenticação ou com usuário e senha) e escolha se quer receber todos os eventos ou só alguns.

   

3. Se escolheu os eventos, ative os que quer receber. Depois, clique em Criar.

   

Histórico de eventos

O histórico de eventos de integração do Painel do Gestor lista cada envio feito para a sua URL, com o identificador, o evento e a data e hora.

Em Ver detalhes, a aba Requisição mostra os headers e o corpo enviados, e a aba Resposta mostra o que a sua aplicação respondeu.