Accounts

Account webhooks are emitted by the Accounts API when account-level configuration or preferences change (e.g. connex preferences, design, email settings, S3 buckets, terms & conditions). The payload is the full account document.

Events

Action Event name
update connex preferences account.updated
update account preferences account.updated
update account setup account.updated
update design preferences account.updated
update email settings account.updated
update scanning preferences account.updated
update terms & conditions account.updated
add or update or delete s3 bucket account.updated

Payload example

{
 "_id": "string",
 "createdAt": {
  "offset": "int",
  "value": "string"
 },
 "deleted": "boolean",
 "domain": "string",
 "lexiconKeys": {
  "optInMessage": "string",
  "terms": "string"
 },
 "name": "string",
 "preferences": {
  "newSales": "boolean",
  "pricesIncludeTaxes": "boolean",
  "customerAccounts": {
   "customerPhone": "boolean",
   "customerPhoneType": "boolean",
   "enabled": "boolean",
   "optIn": "boolean",
   "optInMessage": "string",
   "selfServeChange": "boolean"
  },
  "pdfTicket": {
   "autoPrint": "boolean",
   "custom": "boolean",
   "customPrinterModel": "string",
   "hidePrices": "boolean",
   "tripName": "boolean"
  },
  "useReceiptFieldsForProviderProducts": "boolean",
  "reverseScanningForTickets": "boolean",
  "scanningMode": "string",
  "calendarWebsales": {
   "lexiconKeys": {
    "calendarPageInformation": "string"
   }
  },
  "promos": {
   "useAutocomplete": "boolean"
  },
  "hasWlSchema": "boolean",
  "ticketsCancellationChain": "boolean",
  "scanningWorkflow": "string",
  "measuresSystem": "string",
  "accountCountry": "string",
  "visibleTripsDaysGap": "int",
  "tripResults": {
   "numberOfResultsPerPage": "int"
  },
  "lexicon": "string",
  "supportedCurrencies": [
   {
    "channels": [
     "string"
    ],
    "enabled": "boolean",
    "exchangeRates": [
     {
      "buy": "int",
      "sell": "int",
      "updatedAt": {
       "offset": "int",
       "value": "string"
      },
      "updatedBy": "string"
     }
    ],
    "isocode": "string",
    "symbol": "string"
   }
  ],
  "applications": [
   "string"
  ],
  "vouchers": {
   "enabledForAll": "boolean",
   "instructions": "string",
   "toc": "string"
  },
  "acceptToc": "boolean",
  "dateFormat": "string",
  "calendarWebsalesEnabled": "boolean",
  "multiCurrency": "boolean",
  "newLayout": "boolean",
  "s3buckets": [],
  "premium": [
   "string"
  ],
  "shortUrls": {
   "fullPage": {
    "longUrl": "string",
    "shortUrl": "string"
   },
   "widget": {
    "longUrl": "string",
    "shortUrl": "string"
   }
  },
  "pricing": {
   "journeyPricing": {
    "byMarket": "boolean"
   }
  },
  "timeFormat": "string",
  "rounding": {
   "decimals": "string",
   "policy": "string"
  },
  "crossBorderTaxation": "boolean",
  "journeyPricing": {
   "weighting": [
    {
     "fields": [
      "string"
     ],
     "rank": "int"
    }
   ]
  },
  "workflow": "string",
  "crossProductRedemption": "boolean",
  "google": {
   "analytics": "string"
  },
  "ticketFields": {
   "footer": {
    "content": "string",
    "label": "string",
    "order": "int"
   }
  },
  "network": {
   "isOperator": "boolean",
   "isSeller": "boolean",
   "searchableOperator": "boolean",
   "searchableSeller": "boolean"
  },
  "commIdentity": [
   {
    "active": "boolean",
    "email": "string",
    "name": "string",
    "verified": "boolean"
   }
  ],
  "expandedDownloadDateRange": "boolean",
  "wl": {
   "cache": {
    "advancedCacheOnSameDay": "boolean",
    "numberOfDaysUsage": "int",
    "numberOfEntryUsage": "int",
    "useCache": "boolean"
   },
   "minWaitingTime": "int",
   "schema": "string"
  },
  "connex": {
   "cache": {
    "advancedCacheOnSameDay": "boolean",
    "numberOfDaysUsage": "int",
    "numberOfEntryUsage": "int",
    "useCache": "boolean"
   },
   "enabled": "boolean",
   "filter": {
    "enabled": "boolean",
    "minutes": "int",
    "percentage": "int"
   },
   "maxConnexWithDirectTrips": "int",
   "maxWaitingTime": "string",
   "minWaitingTime": "string",
   "version": "int"
  },
  "languages": {
   "de": "boolean",
   "en": "boolean",
   "es": "boolean",
   "fr": "boolean",
   "nl": "boolean"
  },
  "defaultCountry": "string",
  "paymentProviders": {
   "cash": {
    "_id": "string",
    "allowPaidItemChanges": "boolean",
    "allowToCombine": "boolean",
    "appliesOnlyWhenLoggedIn": "boolean",
    "channels": {
     "agency-backoffice": {
      "accepted": [],
      "available": "boolean"
     },
     "agency-websales": {
      "available": "boolean"
     },
     "backoffice": {
      "accepted": [],
      "available": "boolean"
     },
     "websales": {
      "available": "boolean"
     }
    },
    "creditCards": {},
    "custom": "boolean",
    "displayName": "string",
    "editableAmount": "boolean",
    "editablePaymentAdjustor": "boolean",
    "enabled": "boolean",
    "excludedCombinations": [],
    "externalSource": "boolean",
    "externalType": "string",
    "flow": "string",
    "hasRefund": "boolean",
    "help": "string",
    "helpByField": {},
    "inBtrzpay": "boolean",
    "includeInDepositTotals": "boolean",
    "isOnline": "boolean",
    "method": "string",
    "onlineRefund": "boolean",
    "ord": "int",
    "paymentAdjustor": "int",
    "provider": "string",
    "providerName": "string",
    "requireAddress": "boolean",
    "requireAddressBackoffice": "boolean",
    "requireAddressWebsales": "boolean",
    "requireConfirmation": "boolean"
   }
  },
  "sales": {
   "allowChangeFareTypeOnChange": "boolean",
   "allowReissueToAPastDate": "boolean",
   "enableArbitraryRefunds": "boolean",
   "noTripsCustomMessage": "string",
   "optionalEmailAddress": "boolean",
   "passbook": "boolean",
   "quickView": "boolean"
  },
  "timeZone": {
   "daylight": "boolean",
   "name": "string",
   "tz": "string"
  },
  "radiusInMetersToDetectStation": "int",
  "optionalShowFields": {
   "airlineInfoIfAirport": "boolean",
   "commentsPerPax": "boolean",
   "commentsPerPaxAgency": "boolean",
   "commentsPerPaxWidget": "boolean"
  },
  "scanningSyncInterval": "int",
  "bookingSessions": {
   "agency-backoffice": "int",
   "agency-websales": "int",
   "backoffice": "int",
   "websales": "int"
  },
  "acceptTicketsOnCheaperTrips": "boolean",
  "support": {
   "noAccess": "boolean",
   "url": "string"
  },
  "loyaltyProgram": {
   "manualMovementCodes": [
    "string"
   ],
   "payments": [
    "string"
   ],
   "products": [
    "string"
   ]
  },
  "receiptFields": {
   "footer": {
    "content": "string",
    "label": "string",
    "order": "int"
   },
   "header": {
    "content": "string",
    "label": "string",
    "order": "int"
   }
  },
  "manifest": {
   "brakePageOnNewLeg": "boolean",
   "showWalkOnFields": "boolean"
  },
  "validations": {
   "minWindowInSecondsToScanSameTicket": "int",
   "scanFaresValidations": {},
   "validateDateScan": "boolean",
   "validateFareScan": "boolean",
   "validateOandDScan": "boolean",
   "validateTripScan": "boolean"
  },
  "bookingSession": "int",
  "colors": {
   "brandBackground": "string",
   "brandForeground": "string",
   "complementaryBackground": "string",
   "complementaryForeground": "string",
   "mainBackground": "string",
   "mainForeground": "string"
  }
 },
 "roles": [
  {
   "_id": "string",
   "name": "string",
   "system": "boolean"
  },
  {
   "_id": "string",
   "name": "string",
   "newId": "string"
  }
 ],
 "rootDomain": "string",
 "updatedAt": {
  "offset": "int",
  "value": "string"
 },
 "userId": "string"
}