Operations settings

Operation settings webhooks are emitted by the Accounts API when operation settings are updated via PUT /operation-settings.

Events

Action Event name
update operation settings (PUT /operation-settings) operationsettings.updated

Payload example (operationsettings.updated)

The webhook payload includes the standard envelope (id, attemptId, created, event, livemode) and a data object with providerId, apiKey, and the updated operation settings:

{
  "attemptId": "7ffc09a0-954c-46ef-a825-92936b849656",
  "created": 1689110681,
  "data": {
    "providerId": "52a377ec430c7d4e220001fc",
    "apiKey": "the-x-api-key-header-value",
    "data": {
      "allowBusWithoutSeatmapOnManifest": true,
      "schedulesOandDfromRoute": false,
      "defaultScheduleStatus": "published"
    }
  },
  "event": "operationsettings.updated",
  "id": "22f093aa-6555-440e-8691-039ecaddb5e9",
  "livemode": true
}

Payload fields (operationsettings.updated)

Field Type Description
id string Webhook event id
attemptId string Delivery attempt id
created number Unix timestamp when the event was created
event string operationsettings.updated
livemode boolean Whether the account is in live mode
data object Custom payload from the API
data.providerId string Account id (ObjectId) that owns the operation settings
data.apiKey string Value of the X-API-KEY header used in the request
data.data object The updated operation settings document (same shape as GET /operation-settings response operationSettings)