FLfleetio
Webhooks

Update Webhook

Changed on

Update a Webhook

patch/webhooks/{id}

Request

Path parameters

idstring required

The id of the relevant record

Request body

all_eventsboolean
authorizationstring

If the URL requires authentication, the value provided here gets passed as the HTTP 'Authorization' header

contact_archivedboolean
contact_assignedboolean
contact_comment_addedboolean
contact_createdboolean
contact_deletedboolean
contact_mergedboolean
contact_updatedboolean
descriptionstring
enabledboolean
equipment_comment_addedboolean
equipment_createdboolean
equipment_deletedboolean
equipment_updatedboolean
expense_entry_comment_addedboolean
expense_entry_createdboolean
expense_entry_deletedboolean
expense_entry_updatedboolean
fault_createdboolean
fault_resolvedboolean
fuel_entry_comment_addedboolean
fuel_entry_createdboolean
fuel_entry_deletedboolean
fuel_entry_updatedboolean
import_completedboolean
issue_closedboolean
issue_comment_addedboolean
issue_createdboolean
issue_deletedboolean
issue_resolvedboolean
issue_updatedboolean
location_entry_createdboolean
location_entry_deletedboolean
location_entry_updatedboolean
meter_entry_createdboolean
meter_entry_deletedboolean
meter_entry_updatedboolean
part_comment_addedboolean
part_createdboolean
part_deletedboolean
part_updatedboolean
place_createdboolean
place_deletedboolean
place_updatedboolean
place_visitedboolean
purchase_order_approvedboolean
purchase_order_closedboolean
purchase_order_comment_addedboolean
purchase_order_createdboolean
purchase_order_deletedboolean
purchase_order_pending_approvalboolean
purchase_order_purchasedboolean
purchase_order_receivedboolean
purchase_order_updatedboolean
service_entry_comment_addedboolean
service_entry_createdboolean
service_entry_deletedboolean
service_entry_updatedboolean
submitted_inspection_form_createdboolean
submitted_inspection_form_deletedboolean
urlstring

*Must begin with http:// or https://

user_createdboolean
user_updatedboolean
user_archivedboolean
vehicle_archivedboolean
vehicle_assignedboolean
vehicle_assignment_createdboolean
vehicle_assignment_deletedboolean
vehicle_assignment_updatedboolean
vehicle_comment_addedboolean
vehicle_createdboolean
vehicle_deletedboolean
vehicle_group_changedboolean
vehicle_status_changedboolean
vehicle_updatedboolean
vendor_comment_addedboolean
vendor_createdboolean
vendor_deletedboolean
vendor_updatedboolean
work_order_comment_addedboolean
work_order_createdboolean
work_order_deletedboolean
work_order_document_addedboolean
work_order_status_changedboolean
work_order_updatedboolean

Response

OK

idinteger
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

account_idinteger required
all_eventsboolean

Indicates whether or not this Webhook should be triggered by all events.

authorizationstring nullable

The authorization header to include in the request to the URL specified by url.

descriptionstring nullable

A description of this Webhook.

disabled_atstring date-time nullable

The date and time at which the Webhook was disabled.

disabled_reasonstring nullable

The reason this Webhook was disabled. This field is only present if disabled_at is present.

enabledboolean

Indicates whether or not this Webhook is enabled. If false, the Webhook will not be triggered.

failed_attemptsinteger

The number of instances of this Webhook that have failed to be handled by the endpoint (after retries have been exhausted). If this number exceeds the value of 3, the Webhook will be disabled.

shared_keystring

The shared key to verify that incoming messages came from Fleetio.

subscribed_eventsobject

The events that this Webhook is subscribed to. If all_events is true, this field will be ignored.

urlstring uri required

The URL to which this Webhook will send a POST request when triggered.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "disabled_at": "2023-03-14T13:46:27-06:00"
}

Changes