> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gohusky.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Evento

> Evento de notificação enviado por webhook.

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 |


## OpenAPI

````yaml WEBHOOK event
openapi: 3.1.0
info:
  title: API Pública
  description: >-
    API da Husky, teste uma plataforma de logística para delivery e entregas.
    Aqui você encontra todas as informações necessárias para integrar o sistema
    Husky em seu aplicativo ou sistema.
  version: 0.0.1
servers:
  - url: https://sandbox.api.gohusky.net
    description: Ambiente de Homologação, use para testes e desenvolvimento.
  - url: https://api.gohusky.net
    description: Ambiente de Produção, use para produção.
security: []
paths: {}

````