Skip to main content

Fee export webhook

The invoice_export webhook is sent to the requester when the file of a fee export is ready. It does not carry the download link: when you receive it, query the export to get the link.

The delivery address setup and webhook resending are the same as for every notification. See Notification setup and Notification resending.

Additional fields

New fields may be added to the webhook body. Do not reject the webhook because of fields you do not recognize.

Webhook body​

FieldTypeDescription
webhook_typestringAlways invoice_export.
invoice_export_keyuuidExport key.
invoice_export_statusstringExport status. Currently always done.
row_countintegerNumber of fees in the file.
{
"webhook_type": "invoice_export",
"invoice_export_key": "7a9c0a5e-1b2f-4c3d-9e8f-0123456789ab",
"invoice_export_status": "done",
"row_count": 1250000
}

Errors​

This webhook has no errors of its own. The errors of each export endpoint are on its page: request, list and query.

Next step​

Query the fee export with the invoice_export_key received.