Webhook Event Reference
Below you will find a reference of all webhook events fired from Fleetio. You may subscribe to any of these events from your webhook configuration.
Import Events
Because imports could generate a large number of events, we will not send a created or updated event for each affected record.
- Instead, we will send a single
import_completed
event to your webhook when the import finishes. - Inside the payload, you will find the import types, and three arrays:
affected_record_ids
,created_record_ids
, andupdated_record_ids
. - There is one exception: The Add Multiple Users/Vehicles feature will generate multiple creation events.
We have an Imports API that lets you retrieve a list of the created or updated records for an import.
Event | Description |
---|---|
import_completed | Fired when an import is completed, whether successfully or not. You can check the state attribute to determine if the import was successful or not. A state of complete indicates success. A state of failed indicates something failed. You can then go through the error_messages array to see exactly what failed. On success, the created_record_ids and updated_record_ids arrays will contain the IDs of the records that were either created or updated." |
Example payload for all import events:
Details
Contact Events
Event | Description |
---|---|
contact_created | Fired when a Contact is created. |
contact_updated | Fired when a Contact is updated. |
contact_deleted | Fired when a Contact is deleted. The payload will contain the attributes of the Contact before deletion. |
contact_archived | Fired when a Contact is archived. |
contact_merged | Fired when a Contact is merged into this one. The payload will contain the destination Contact. |
contact_assigned | Fired when a Contact is assigned to a Vehicle. |
contact_comment_added | Fired when a comment is made on a Contact. |
Example payload for all Contact events:
Details
DTC Alert Events
Event | Description |
---|---|
dtc_alert_created | Fired when a DTC Alert is created. |
dtc_alert_resolved | Fired when a DTC Alert is resolved. |
Example payload for all DTC Alert events:
Details
Equipment Events
Event | Description |
---|---|
equipment_created | Fired when Equipment is created. |
equipment_updated | Fired when an attribute on Equipment is updated. |
equipment_deleted | Fired when Equipment is deleted. The payload will contain the attributes of the Equipment before it was deleted. |
equipment_comment_added | Fired when a comment is made on Equipment |
Example payload for all Equipment events:
Details
Expense Entry Events
Expense Entries are automatically generated when an Acquisition (a loan or a lease) is created. This includes all current expenses and future expenses. Fleetio will fire creation events for all future Expense Entries, so your endpoint should check the occurred_at
field to determine if this is a future expense or not.
Event | Description |
---|---|
expense_entry_created | Fired when an Expense Entry is created. |
expense_entry_updated | Fired when an Expense Entry is updated. |
expense_entry_deleted | Fired when an Expense Entry is deleted. The payload will contain the Expense Entry's attributes before deletion. |
expense_entry_comment_added | Fired when a comment is made on an Expense Entry. |
Example payload for all Expense Entry events:
Details
Fuel Entry Events
Event | Description |
---|---|
fuel_entry_created | Fired when a Fuel Entry is created. |
fuel_entry_updated | Fired when a Fuel Entry is updated. |
fuel_entry_deleted | Fired when a Fuel Entry is deleted. The payload will contain the Fuel Entry's attributes before it was deleted |
fuel_entry_comment_added | Fired when a comment is made on a Fuel Entry. |
Example payload for all Fuel Entry events:
Details
Inspection Submission Events
Event | Description |
---|---|
submitted_inspection_form_created | Fired when an Inspection is submitted. |
submitted_inspection_form_deleted | Fired when an Inspection is deleted. |
Example payload for all Submitted Inspection Form events:
Details
Issue Events
Event | Description |
---|---|
issue_created | Fired when an Issue is created. |
issue_updated | Fired when an Issue is updated. |
issue_deleted | Fired when an Issue is deleted. The payload will contain the Issue's attributes before deletion. |
issue_resolved | Fired when an Issue is resolved. |
issue_closed | Fired when an Issue is closed. |
issue_comment_added | Fired when a comment is made on an Issue. |
Example payload for all Issue events:
Details
Location Entry Events
Event | Description |
---|---|
location_entry_created | Fired when a Location Entry is created. |
location_entry_updated | Fired when a Location Entry is updated. |
location_entry_delete | Fired when a Location Entry is deleted. The payload will contain the Location Entry's attributes before deletion. |
Example payload for all Location Entry events:
Details
Meter Entry Events
Meter Entry events are only fired on manual Meter Entries (e.g. ones that are not associated with another resource, such as a Fuel Entry or Service Entry).
Event | Description |
---|---|
meter_entry_created | Fired when a manual meter entry is created. |
meter_entry_updated | Fired when a manual meter entry is updated. |
meter_entry_deleted | Fired when a manual meter entry is deleted. The payload will contain the meter entry's attributes before deletion. |
Example payload for all Meter Entry events:
Details
Part Events
Event | Description |
---|---|
part_created | Fired when a Part is created. |
part_updated | Fired when a Part is updated. |
part_deleted | Fired when a Part is deleted. The payload will contain the Part's attributes before deletion. |
part_comment_added | Fired when a Comment is made on a Part. |
Example payload for all Part events:
Details
Place Events
Event | Description |
---|---|
place_created | Fired when a Place is created. |
place_updated | Fired when a Place is updated. |
place_deleted | Fired when a Place is deleted. The payload will contain the Place's attributes before deletion. |
place_visited | Fired when a Place is visited. |
Example payload for all Place events:
Details
Purchase Order Events
Event Name | Description |
---|---|
purchase_order_created | Fired when a Purchase Order is created. |
purchase_order_updated | Fired when a Purchase Order is updated. This event is not fired when the Purchase Order state changes. |
purchase_order_pending_approval | Fired when a Purchase Order enters the pending approval state. |
purchase_order_approved | Fired when a Purchase Order is approved. |
purchase_order_purchased | Fired when a Purchase Order is marked as purchased. |
purchase_order_received | Fired when a Purchase Order is fully received. |
purchase_order_closed | Fired when a Purchase Order is closed. |
purchase_order_deleted | Fired when a Purchase Order is deleted. The payload will contain the Purchase Order's attributes before deletion. |
purchase_order_comment_added | Fired when a Comment is made on a Purchase Order. |
Example payload for all Purchase Order events:
Details
Service Entry Events
Event | Description |
---|---|
service_entry_created | Fired when a Service Entry is created. |
service_entry_updated | Fired when a Service Entry is updated. |
service_entry_deleted | Fired when a Service Entry is deleted. The payload will contain the attributes of the Service Entry before it was deleted. |
service_entry_comment_added | Fired when a Comment is made on a Service Entry. |
Example payload for all Service Entry events:
Details
User Events
Event | Description |
---|---|
user_created | Fired when a User is created. |
user_updated | Fired when a User is updated. |
user_archived | Fired when a User is archived. |
Example payload for all User events:
Details
Vehicle Assignment Events
Event | Description |
---|---|
vehicle_assignment_created | Fired when a Vehicle Assignment is created. |
vehicle_assignment_updated | Fired when a Vehicle Assignment is updated. |
vehicle_assignment_deleted | Fired when a Vehicle Assignment is deleted. |
Example payload for Vehicle Assignment events:
Details
Vendor Events
Event | Description |
---|---|
vendor_created | Fired when a Vendor is created. |
vendor_updated | Fired when a Vendor is updated. |
vendor_deleted | Fired when a Vendor is deleted. The payload will contain the Vendor's attributes before deletion. |
vendor_comment_added | Fired when a Comment is made on a Vendor. |
Example payload for all Vendor events:
Details
Vehicle Events
Event | Description |
---|---|
vehicle_created | Fired when a Vehicle is created. |
vehicle_updated | Fired when an attribute on a Vehicle is updated. |
vehicle_status_changed | Fired when a Vehicle's status changes. |
vehicle_group_changed | Fired when a Vehicle's group changes. |
vehicle_archived | Fired when a Vehicle is archived. |
vehicle_deleted | Fired when a Vehicle is deleted. The payload will contain the attributes of the Vehicle before it was deleted. |
vehicle_assigned | Fired when a Vehicle Assignment is created for a Vehicle. |
vehicle_comment_added | Fired when a Comment is made on a Vehicle. |
Example payload for all Vehicle events:
Details
Work Order Events
Event | Description |
---|---|
work_order_created | Fired when a Work Order is created. |
work_order_updated | Fired when a Work Order is updated. |
work_order_deleted | Fired when a Work Order is deleted. The payload will contain the Work Order's attributes before deletion. |
work_order_status_changed | Fired when the status of a Work Order changes. |
work_order_comment_added | Fired when a Comment is made on a Work Order. |
Example payload for all Work Order events: