Evento

{
  "event_context": "1234567890",
  "customer": "1234567890",
  "resource": {
    "order": {
      "addresses": {
        "pickup": {
          "name": "BIM FILMES",
          "phone": "1234567890",
          "address": "Rua dos Andradas, 1155 - Centro Histórico, Porto Alegre - RS, Brasil",
          "lat": -30.030161,
          "lng": -51.230108,
          "comp": "5858",
          "neighborhood": "Centro Histórico",
          "city": "Porto Alegre",
          "state": "RS",
          "country": "Brasil",
          "obs": "Observações adicionais"
        },
        "dropoff": {
          "name": "BIM FILMES",
          "phone": "1234567890",
          "address": "Rua dos Andradas, 1155 - Centro Histórico, Porto Alegre - RS, Brasil",
          "lat": -30.030161,
          "lng": -51.230108,
          "comp": "5858",
          "neighborhood": "Centro Histórico",
          "city": "Porto Alegre",
          "state": "RS",
          "country": "Brasil",
          "obs": "Observações adicionais"
        },
        "orderDetails": {
          "client": "1234567890",
          "subclient": "1234567890",
          "tracking": "051aa70b607f97beeba3f5f9ee2a6b984a9f1489c3a74d6083afc59e1685cb2a",
          "number": 1234567890,
          "cod": "1234567890",
          "requester": "1234567890",
          "size": 0,
          "status": 1,
          "fleet": 1,
          "scheduled": 1,
          "sign": 1,
          "signName": "John Doe",
          "signTime": "2020-06-26 22:24:30",
          "price": 100,
          "waitingPrice": 100,
          "costCenter": 1,
          "opObs": "Observações adicionais",
          "optionalService": 1,
          "vehicle": 1,
          "return": 1,
          "paymentType": 1,
          "distance": 100,
          "times": {
            "created": "2020-06-26 22:24:30",
            "schedule": "2020-06-26 22:24:30",
            "pickup": "2020-06-26 22:24:30",
            "started": "2020-06-26 22:24:30",
            "dropoff": "2020-06-26 22:24:30",
            "closed": "2020-06-26 22:24:30",
            "eta": "2020-06-26 22:24:30"
          }
        }
      }
    }
  },
  "event_id": "<string>",
  "date": "2020-06-26 22:24:30"
}

WEBHOOK

event

{
  "event_context": "1234567890",
  "customer": "1234567890",
  "resource": {
    "order": {
      "addresses": {
        "pickup": {
          "name": "BIM FILMES",
          "phone": "1234567890",
          "address": "Rua dos Andradas, 1155 - Centro Histórico, Porto Alegre - RS, Brasil",
          "lat": -30.030161,
          "lng": -51.230108,
          "comp": "5858",
          "neighborhood": "Centro Histórico",
          "city": "Porto Alegre",
          "state": "RS",
          "country": "Brasil",
          "obs": "Observações adicionais"
        },
        "dropoff": {
          "name": "BIM FILMES",
          "phone": "1234567890",
          "address": "Rua dos Andradas, 1155 - Centro Histórico, Porto Alegre - RS, Brasil",
          "lat": -30.030161,
          "lng": -51.230108,
          "comp": "5858",
          "neighborhood": "Centro Histórico",
          "city": "Porto Alegre",
          "state": "RS",
          "country": "Brasil",
          "obs": "Observações adicionais"
        },
        "orderDetails": {
          "client": "1234567890",
          "subclient": "1234567890",
          "tracking": "051aa70b607f97beeba3f5f9ee2a6b984a9f1489c3a74d6083afc59e1685cb2a",
          "number": 1234567890,
          "cod": "1234567890",
          "requester": "1234567890",
          "size": 0,
          "status": 1,
          "fleet": 1,
          "scheduled": 1,
          "sign": 1,
          "signName": "John Doe",
          "signTime": "2020-06-26 22:24:30",
          "price": 100,
          "waitingPrice": 100,
          "costCenter": 1,
          "opObs": "Observações adicionais",
          "optionalService": 1,
          "vehicle": 1,
          "return": 1,
          "paymentType": 1,
          "distance": 100,
          "times": {
            "created": "2020-06-26 22:24:30",
            "schedule": "2020-06-26 22:24:30",
            "pickup": "2020-06-26 22:24:30",
            "started": "2020-06-26 22:24:30",
            "dropoff": "2020-06-26 22:24:30",
            "closed": "2020-06-26 22:24:30",
            "eta": "2020-06-26 22:24:30"
          }
        }
      }
    }
  },
  "event_id": "<string>",
  "date": "2020-06-26 22:24:30"
}

Trabalhamos com webhooks para notificações de eventos do sistema Husky. Para receber as notificações, é necessário cadastrar a URL de destino e o tipo de evento que será notificado.

Tipos de evento

É possível registrar para receber webhook de entregas, entregadores e embarcadores. Abaixo a lista dos eventos de cada um e o momento em que é feito o disparo.

Eventos de Entrega

Evento	Descrição
ORDER_CREATED	Disparado quando uma nova entrega é criada
ORDER_UPDATED	Disparado quando uma entrega é atualizada
ORDER_STATUS_UPDATED	Disparado quando o status de uma entrega é atualizado (ex: coletando, entregando, etc)
ORDER_DRIVER_UPDATED	Disparado quando alterado o entregador de uma entrega

Eventos de Entregador

Evento	Descrição
FLEET_QUEUE	Disparado quando um entregador sai da cerca virtual do embarcador
DRIVER_CREATED	Disparado quando um novo entregador é criado
DRIVER_UPDATED	Disparado quando alterado algum dado de um entregador
DRIVER_STATUS_UPDATED	Disparado quando alterado o status do entregador (ex: inativado no sistema)

Eventos de Embarcador

Evento	Descrição
CLIENT_CREATED	Disparado quando um novo embarcador é criado
CLIENT_UPDATED	Disparado quando alterado os dados de um embarcador
CLIENT_STATUS_UPDATED	Disparado quando alterado o status de um embarcador

Body

application/json

Resource

event_context

string

Token da operação

Example:

"1234567890"

customer

string

Token do embarcador

Example:

"1234567890"

resource

object

Show child attributes

event

enum<string>

Available options:

ORDER_CREATED,

ORDER_UPDATED,

ORDER_STATUS_UPDATED,

ORDER_DRIVER_UPDATED,

CLIENT_CREATED,

CLIENT_UPDATED,

CLIENT_STATUS_UPDATED,

DRIVER_CREATED,

DRIVER_UPDATED,

DRIVER_STATUS_UPDATED,

FLEET_QUEUE

event_id

string

ID do evento

date

string

Data do evento (em UTC)

Example:

"2020-06-26 22:24:30"

Deletar webhook

Introdução

Embarcadores

Entregas

Entregadores

Webhooks

Tipos de evento

Eventos de Entrega

Eventos de Entregador

Eventos de Embarcador

Body

​Tipos de evento

​Eventos de Entrega

​Eventos de Entregador

​Eventos de Embarcador

Body

Tipos de evento

Eventos de Entrega

Eventos de Entregador

Eventos de Embarcador