Update Webhook

PATCH https://secure.fleetio.com/api/v1/webhooks/:id

Update a Webhook

Request

Path Parameters

id stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The id of the relevant record

application/json

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://

Possible values: <= 1000 characters

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_status_changedboolean

work_order_updatedboolean

Responses

Response Headers

application/json

Schema
Example (auto)

Schema

idinteger

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

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

Example: 2023-03-14T13:46:27-06:00

account_idId (integer)required

Possible values: >= 1

all_eventsboolean

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

authorizationstringnullable

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

descriptionstringnullable

A description of this Webhook.

disabled_atdate-timenullable

The date and time at which the Webhook was disabled.

Example: 2023-03-14T13:46:27-06:00

disabled_reasonstringnullable

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 times this Webhook has failed to be triggered. 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_events object

urlurirequired

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

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "all_events": true,
  "authorization": "string",
  "description": "string",
  "disabled_at": "2023-03-14T13:46:27-06:00",
  "disabled_reason": "string",
  "enabled": true,
  "failed_attempts": 0,
  "shared_key": "string",
  "subscribed_events": {},
  "url": "string"
}

Request could not be authenticated

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

The requested resource could not be located

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Unprocessable Entity

application/json

Schema
Example (auto)
Example

Schema

errors object

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

CURL

curl -L -X PATCH 'https://secure.fleetio.com/api/v1/webhooks/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "all_events": true,
  "authorization": "string",
  "contact_archived": true,
  "contact_assigned": true,
  "contact_comment_added": true,
  "contact_created": true,
  "contact_deleted": true,
  "contact_merged": true,
  "contact_updated": true,
  "description": "string",
  "enabled": true,
  "equipment_comment_added": true,
  "equipment_created": true,
  "equipment_deleted": true,
  "equipment_updated": true,
  "expense_entry_comment_added": true,
  "expense_entry_created": true,
  "expense_entry_deleted": true,
  "expense_entry_updated": true,
  "fault_created": true,
  "fault_resolved": true,
  "fuel_entry_comment_added": true,
  "fuel_entry_created": true,
  "fuel_entry_deleted": true,
  "fuel_entry_updated": true,
  "import_completed": true,
  "issue_closed": true,
  "issue_comment_added": true,
  "issue_created": true,
  "issue_deleted": true,
  "issue_resolved": true,
  "issue_updated": true,
  "location_entry_created": true,
  "location_entry_deleted": true,
  "location_entry_updated": true,
  "meter_entry_created": true,
  "meter_entry_deleted": true,
  "meter_entry_updated": true,
  "part_comment_added": true,
  "part_created": true,
  "part_deleted": true,
  "part_updated": true,
  "place_created": true,
  "place_deleted": true,
  "place_updated": true,
  "place_visited": true,
  "purchase_order_approved": true,
  "purchase_order_closed": true,
  "purchase_order_comment_added": true,
  "purchase_order_created": true,
  "purchase_order_deleted": true,
  "purchase_order_pending_approval": true,
  "purchase_order_purchased": true,
  "purchase_order_received": true,
  "purchase_order_updated": true,
  "service_entry_comment_added": true,
  "service_entry_created": true,
  "service_entry_deleted": true,
  "service_entry_updated": true,
  "submitted_inspection_form_created": true,
  "submitted_inspection_form_deleted": true,
  "url": "string",
  "user_created": true,
  "user_updated": true,
  "user_archived": true,
  "vehicle_archived": true,
  "vehicle_assigned": true,
  "vehicle_assignment_created": true,
  "vehicle_assignment_deleted": true,
  "vehicle_assignment_updated": true,
  "vehicle_comment_added": true,
  "vehicle_created": true,
  "vehicle_deleted": true,
  "vehicle_group_changed": true,
  "vehicle_status_changed": true,
  "vehicle_updated": true,
  "vendor_comment_added": true,
  "vendor_created": true,
  "vendor_deleted": true,
  "vendor_updated": true,
  "work_order_comment_added": true,
  "work_order_created": true,
  "work_order_deleted": true,
  "work_order_status_changed": true,
  "work_order_updated": true
}'

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

Body

{
  "all_events": true,
  "authorization": "string",
  "contact_archived": true,
  "contact_assigned": true,
  "contact_comment_added": true,
  "contact_created": true,
  "contact_deleted": true,
  "contact_merged": true,
  "contact_updated": true,
  "description": "string",
  "enabled": true,
  "equipment_comment_added": true,
  "equipment_created": true,
  "equipment_deleted": true,
  "equipment_updated": true,
  "expense_entry_comment_added": true,
  "expense_entry_created": true,
  "expense_entry_deleted": true,
  "expense_entry_updated": true,
  "fault_created": true,
  "fault_resolved": true,
  "fuel_entry_comment_added": true,
  "fuel_entry_created": true,
  "fuel_entry_deleted": true,
  "fuel_entry_updated": true,
  "import_completed": true,
  "issue_closed": true,
  "issue_comment_added": true,
  "issue_created": true,
  "issue_deleted": true,
  "issue_resolved": true,
  "issue_updated": true,
  "location_entry_created": true,
  "location_entry_deleted": true,
  "location_entry_updated": true,
  "meter_entry_created": true,
  "meter_entry_deleted": true,
  "meter_entry_updated": true,
  "part_comment_added": true,
  "part_created": true,
  "part_deleted": true,
  "part_updated": true,
  "place_created": true,
  "place_deleted": true,
  "place_updated": true,
  "place_visited": true,
  "purchase_order_approved": true,
  "purchase_order_closed": true,
  "purchase_order_comment_added": true,
  "purchase_order_created": true,
  "purchase_order_deleted": true,
  "purchase_order_pending_approval": true,
  "purchase_order_purchased": true,
  "purchase_order_received": true,
  "purchase_order_updated": true,
  "service_entry_comment_added": true,
  "service_entry_created": true,
  "service_entry_deleted": true,
  "service_entry_updated": true,
  "submitted_inspection_form_created": true,
  "submitted_inspection_form_deleted": true,
  "url": "string",
  "user_created": true,
  "user_updated": true,
  "user_archived": true,
  "vehicle_archived": true,
  "vehicle_assigned": true,
  "vehicle_assignment_created": true,
  "vehicle_assignment_deleted": true,
  "vehicle_assignment_updated": true,
  "vehicle_comment_added": true,
  "vehicle_created": true,
  "vehicle_deleted": true,
  "vehicle_group_changed": true,
  "vehicle_status_changed": true,
  "vehicle_updated": true,
  "vendor_comment_added": true,
  "vendor_created": true,
  "vendor_deleted": true,
  "vendor_updated": true,
  "work_order_comment_added": true,
  "work_order_created": true,
  "work_order_deleted": true,
  "work_order_status_changed": true,
  "work_order_updated": true
}

ResponseClear

Click the Send API Request button above and see the response here!

Update Webhook

https://secure.fleetio.com/api/v1/webhooks/:id

Request​

Path Parameters

Body

Responses​

Authorization: Authorization

Request

Responses