Skip to navigation
API ReferenceWebhooks

Create endpoint

View as Markdown

Scope: webhooks:write

Registers a URL to receive events. The response includes signing_secret — this is the only time it is shown, so store it to verify deliveries.

  • url (string, required) — public https:// URL
  • events (array, required) — event names from GET /webhooks/events
  • description (string, optional)

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.

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"<=255 characters

A public https URL.

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

Response

Created
idstringOptional
urlstringOptional
descriptionstringOptional
statusstringOptional
typestringOptional
eventslist of stringsOptional
created_atstringOptional
updated_atstringOptional
signing_secretstringOptional

Errors

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