v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Update a webhook

put/v1/company_webhooks/{id}

Path parameters

idinteger required

Specify the ID of the Webhook that you want to update.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Request body

urlstring

Specify the URL of the Webhook endpoint.

secretstring

Specify the shared secret that will be used to fetch the data. NOTE: Must be 20 characters. If left blank, will be generated automatically.

formatstring

Payload format for the webhook (only json is supported at this time).

actionsstring[]

Specify a list of actions that will be supported by the Webhook.

enabledboolean

Specify if you want to activate this Webhook. Set TRUE to activate. Set FALSE to disable.

Response

200

Example response

{
  "company_webhook": {
    "id": 27,
    "url": "https://keeptruckin.com/callbacktest/bd0421",
    "secret": "67298a4636cb6e07ceabf750bb63e99d",
    "format": "json",
    "actions": [
      "vehicle_location_updated"
    ],
    "enabled": true
  }
}