v1

latestOpenAPI 3.1.02026-08-06230114.0 KB

Webhooks

Update Webhook

put/v1/webhooks/{webhookId}

Path parameters

webhookIdstring required

Headers

Authorizationstring

User access token

Content-Type'application/json'

Request body

namestring required

Name of the webhook

urlstring uri required

URL to send webhook events to

authKeystring required

Authorization key to use for webhook source verification

eventsstring[] required

List of events that the webhook is subscribed to

activeboolean

Whether the webhook is active

Example request

{
  "name": "Example Webhook",
  "url": "https://www.exampleapp.com/webhook",
  "authKey": "9WVPxCzIUacIehyUKgJkqz4fQaZwnrs9DVy4yB",
  "events": [
    "tripStart",
    "tripEnd",
    "mil"
  ],
  "active": true
}

Response

Returns the updated webhook

idstring required

Unique identifier

namestring required

Name of the webhook

urlstring required

URL to send webhook events to

authKeystring required

Authorization key to use for webhook source verification

applicationIdstring required

Application ID that the webhook is associated with

eventsstring[] required

List of events that the webhook is subscribed to

activeboolean required

Whether the webhook is active

createdAtstring date-time required

Time the webhook was created

updatedAtstring date-time required

Time the webhook was last updated

Example response

{
  "id": "65f8a2b4c9d7e1234567890b",
  "name": "Example Webhook",
  "url": "https://www.exampleapp.com/webhook",
  "authKey": "9WVPxCzIUacIehyUKgJkqz4fQaZwnrs9DVy4yB",
  "applicationId": "65f8a2b4c9d7e1234567890c",
  "events": [
    "tripStart",
    "tripEnd"
  ],
  "active": true,
  "createdAt": "2026-01-01T08:30:00.000Z",
  "updatedAt": "2026-01-01T08:30:00.000Z"
}