Criar webhook

Registra uma URL pública para receber eventos de pedidos da Abbiamo.

Cada chamada registra uma URL por event_type. Os tipos disponíveis são:

event_typeQuando é disparado
DELIVERY_REQUESTUma nova solicitação de entrega foi despachada para a transportadora.
CANCELLATION_REQUESTO cliente solicitou o cancelamento de uma entrega.
PICKUP_PIN_VALIDATION_REQUESTWebhook síncrono de validação do pincode de coleta no modelo motorista → loja.

Registre o PICKUP_PIN_VALIDATION_REQUEST apenas se a sua integração suporta o modelo motorista → loja (pincode_owner = "abbiamo"). Veja Pincode de coleta para entender os dois modelos e Validação do pincode de coleta para os requisitos do handler (resposta síncrona, idempotência e timeout). Transportadoras que ainda não suportam esse modelo podem deixar de registrar essa URL — nesse caso a Abbiamo não despacha entregas com pincode_owner = "abbiamo" para a integração.

POST
/v1/carrier/webhook

Authorization

carrierKey
x-abbiamo-carrier-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/carrier/webhook" \  -H "Content-Type: application/json" \  -d '{    "event_type": "DELIVERY_REQUEST",    "url": "string"  }'
{}
{}