Webhooks são notificações geradas em tempo real a partir de alterações em recursos específicos.

Hoje, qualquer alteração relevante de estado no recurso "orders" dispara uma requisição POST com corpo em JSON para as URLs cadastradas no painel da Flixlog.

Exemplo de requisição

curl -X 'POST' \
    -H 'content-type: application/json' \
    'https://webhook.site/...' \
    -d $'{
            "event":"order-status-update",
            "payload":{
                "id":9099,
                "reference":"PEDIDO1246",
                "status":{
                    "id":5,
                    "code":"delivered",
                    "description":"Entrega realizada com sucesso"
                }
            }
        }'

Cadastro de URL

Para cadastrar é só entrar no Painel da Flixlog > Configurações > Integrações > Adicionar Webhook.

Possíveis eventos

Evento

Descrição

order-status-update

Ocorre sempre que há uma alteração de status no pedido

Códigos de status

status

descrição

new

Aguardando Nota Fiscal

Disparado quando um pedido é criado

pre_transit

Aguardando aceite da transportadora

Disparado quando o xml da nota fiscal é anexado ao pedido

available_for_pickup

Coleta aceita pela transportadora

Disparado quando a transportadora aceita coletar o pedido

in_transit

Em trânsito

Pedido coletado com sucesso

out_for_delivery

Saiu para entrega

O pedido será entregue dentro do horário comercial.

delivered

Entrega realizada com sucesso

Entrega realizada com sucesso