FLfleetio
Webhooks

Retrieve Webhook

Retrieve the details of an existing Webhook.

get/webhooks/{id}

Request

Path parameters

idstring required

The id of the relevant record

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

No recorded changes to this operation across all 1 revision of this API.