Pular para o conteúdo principal

Webhook de exportação de tarifas

O webhook invoice_export é enviado ao requester quando o arquivo de um pedido de exportação de tarifas fica pronto. Ele não traz o link de download: ao recebê-lo, consulte o pedido para obter o link.

A configuração do endereço de recebimento e o reenvio de webhooks são os mesmos de todas as notificações. Ver Configuração de notificação e Reenvio de notificações.

Campos adicionais

Novos campos podem ser incluídos no corpo do webhook. Não rejeite o webhook por campos que você não conhece.

Corpo do webhook​

CampoTipoDescrição
webhook_typestringSempre invoice_export.
invoice_export_keyuuidChave do pedido de exportação.
invoice_export_statusstringStatus do pedido. Hoje sempre done.
row_countintegerQuantidade de tarifas no arquivo.
{
"webhook_type": "invoice_export",
"invoice_export_key": "7a9c0a5e-1b2f-4c3d-9e8f-0123456789ab",
"invoice_export_status": "done",
"row_count": 1250000
}

Erros​

Este webhook não tem erros próprios. Os erros de cada endpoint de exportação estão na página dele: pedir, listar e consultar.

Próximo passo​

Consultar exportação de tarifas com o invoice_export_key recebido.