Webhook

Method: POST

O webhook dispara um HTTP POST para o endpoint informado.

Payload

O payload do webhook é um objeto JSON com a seguinte estrutura:

Parameters

Nome	Tipo	Descrição	Requerido
event	string	O tipo de evento.(CHANGE_STATUS/BREAK_PARCEL/ABOUT_TO_EXPIRE/EXPIRED)	Yes
event_at	data:Y-m-d Hh:ii:ss	O código do pedido.	Yes
order_id	string	O código do pedido.	Yes
order_item_id	string	O ID do item do pedido.	Yes
delivery_date	data:Y-m-d	A data de entrega.	Yes
quantity	int	A quantidade.	Yes
observations	string	As observações de entrega.	Yes
requisition_id	string	O ID da requisição.	No
requisition_item_id	string	O ID do item da requisição.	No
parcel_id	int	O ID da remessa.	Yes

Example

{
    "event": "CHANGE_STATUS",
    "event_at": "2022-11-08 10:00:00",
    "order_id": "4500633125",
    "order_item_id": "000001",
    "delivery_date": "2022-11-08",
    "quantity": 4600000000,
    "observations": "Possível reprogramação - data de reprogramação: 2023-05-17",
    "requisition_id": "",
    "requisition_item_id": "",
    "parcel_id": 1,
}

Responses

Este webhook espera resposta HTTP 200.