Skip to navigation
API ReferenceWebhooks

Update endpoint

View as Markdown

Scope: webhooks:write

Change any of url, description, events (replaces the list) or status (enabled / disabled). Disabled endpoints receive nothing.

Authentication

AuthorizationBearer

An API token from Settings → API tokens in Fleetwire, sent as Authorization: Bearer …. Each token carries scopes: read for every GET, plus write scopes such as bookings:write.

Path parameters

idstringRequired
Endpoint ID

Request

Send only the fields to change.
urlstringOptionalformat: "uri"<=255 characters

A public https URL.

descriptionstring or nullOptional<=255 characters
eventslist of enumsOptional
statusenumOptional
Allowed values:

Response

OK
idstringOptional
urlstringOptional
descriptionstringOptional
statusstringOptional
typestringOptional
eventslist of stringsOptional
created_atstringOptional
updated_atstringOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error