Skip to content
On this page

Sobre Webhooks

Webhooks são notificações enviadas para uma URL específica quando um evento ocorre no sistema. Por exemplo, quando um pedido é criado, um webhook pode ser enviado para uma URL específica para notificar que um pedido foi criado.

A URL que receberá o webhook deve ser configurada no sistema, e o sistema enviará uma solicitação HTTP POST para a URL configurada quando o evento ocorrer.

Configuração

Para configurar um webhook, acesse o menu Integrações e clique no botão Criar webhook.

Dados da requisição

POST /webhook HTTP/1.1
Host: url-do-seu-sistema.com
Content-Length: 372
Content-Type: application/json
Signature: 99dc3769164a1d2e41b4b2403de283d35c1906e9701d2ccc7c761a46a8ec6a20
User-Agent: ..

Corpo da requisição:

json
{
    "event": "shipment.created",
    "payload": {
        "shipment_id": 1,
        "shipment": {
            "id": 3,
            "order_number": "580950",
            "tracking_code": "TR097329",
            "tracking_code_label": "LBL269407",
            "created_by_id": 1,
            "updated_by_id": 3,
            "created_at": "2023-06-28T20:57:23+00:00",
            "updated_at": "2023-07-06T12:18:20+00:00",
            "shipment_status": 1,
            "shipment_status_text": "Rascunho"
        }
    },
    "event_at": "2023-07-06T12:19:32+00:00"
}