🔔 Webhook Events
Available webhook events and their payload structures
Triggered when a car chassis number is corrected/fixed
Payload:
| Field |
Description |
| stock_id |
The car stock ID |
| chassis |
The old chassis number |
| new_chassis |
The new/corrected chassis number |
Triggered when a car is updated
Payload:
| Field |
Description |
| stock_id |
The car stock ID |
| chassis |
The car chassis number |
| ...changes |
All changed fields and their new values |
Triggered when a new invoice is created and billed
Payload:
| Field |
Description |
| id |
The invoice ID |
| number |
The invoice number |
| total_due |
The total amount due |
| currency |
The invoice currency |
| due_date |
The payment due date |
| view_url |
URL to view the invoice |
| download_url |
URL to download the invoice PDF |
Triggered when an invoice is marked as paid
Payload:
| Field |
Description |
| id |
The invoice ID |
| number |
The invoice number |
| total_due |
The total amount due |
| currency |
The invoice currency |
| paid_at |
The payment date and time |
| view_url |
URL to view the invoice |
| download_url |
URL to download the invoice PDF |
Triggered when a voyage status is changed to loaded
Payload:
| Field |
Description |
| voyage_id |
The voyage ID |
| voyage_number |
The voyage number |
| departed_at |
The loaded date and time |
Triggered when a voyage departs
Payload:
| Field |
Description |
| voyage_id |
The voyage ID |
| voyage_number |
The voyage number |
| departed_at |
The departure date and time |
Triggered when a voyage arrives at destination
Payload:
| Field |
Description |
| voyage_id |
The voyage ID |
| voyage_number |
The voyage number |
| departed_at |
The arrival date and time |
Triggered when an Export Declaration (ED) document is uploaded and made visible
Payload:
| Field |
Description |
| voyage_id |
The associated voyage ID |
| voyage_number |
The associated voyage number |
| url |
URL to access the uploaded Export Declaration package |