Websales config

Websales config webhooks are emitted by the Accounts API. Created/deleted when a domain is created or deleted (POST /domains, DELETE /domains/:id). Updated when a websales config is updated (PUT /websales-config/:websalesConfigId).

Events

Action Event name
creating a domain (POST /domains) websalesConfig.created
updating a websales config (PUT /websales-config/:websalesConfigId) websalesConfig.updated
deleting a domain (DELETE /domains/:id) websalesConfig.deleted

Payload example created

{
  "attemptId": "15b4cd65-a0bb-485e-997b-f244fec0ca20",
  "created": 1640621211,
  "data": {
    "domain": "domain"
  },
  "event": "websalesConfig.created",
  "id": "e0870b6e-d0ca-4edb-af8b-a599266ad8b1",
  "livemode": true
}

Payload fields (websalesConfig.created)

Field Type Description
data.domain string Domain associated with the created websales config

Payload example updated

{
  "attemptId": "15b4cd65-a0bb-485e-997b-f244fec0ca20",
  "created": 1640621211,
  "data": {
    "_id": "6261875eaad6f32745351fe2",
    "accountId": "624e08b5fdd69a15e973fcbc",
    "domain": "domain",
    "websales_bgcolor": "",
    "customCss": "",
    "socialSharing": false,
    "fullpageLogoLink": "",
    "fullpageHeadline": "",
    "fullpageInfoHeadline": "",
    "fullpageInfoDetails": "",
    "waitingMessage": "",
    "websales_logoredirecturl": "",
    "disableBackButtonOnTripResults": false,
    "forceLogin": false,
    "sso": {
      "enabled": false,
      "cas": [{
        "id": "",
        "name": "",
        "serverUrl": "",
        "uniqueIdProp": "",
        "validationProperty": "",
        "validationValue": "",
        "propFirstName": "",
        "propLastName": "",
        "propEmail": ""
      }],
      "only": false
    },
    "lexiconKeys": {
      "fullpageHeadline": "624e08b5fdd69a15e973fcbc-websalesConfig-6261875eaad6f32745351fe2-fullpageHeadline",
      "fullpageInfoHeadline": "624e08b5fdd69a15e973fcbc-websalesConfig-6261875eaad6f32745351fe2-fullpageInfoHeadline",
      "fullpageInfoDetails": "624e08b5fdd69a15e973fcbc-websalesConfig-6261875eaad6f32745351fe2-fullpageInfoDetails",
      "ssoErrorMsg": "624e08b5fdd69a15e973fcbc-websalesConfig-6261875eaad6f32745351fe2-ssoErrorMsg"
    },
    "userId": "624e08b5fdd69a15e973fcc0",
    "createdAt": { "value": "2022-04-21T17:59:00.517Z", "offset": 0 },
    "createdBy": "624e08b5fdd69a15e973fcc0",
    "updatedAt": { "value": "2022-04-21T17:59:00.517Z", "offset": 0 },
    "updatedBy": "624e08b5fdd69a15e973fcc0",
    "deleted": false
  },
  "event": "websalesConfig.updated",
  "id": "e0870b6e-d0ca-4edb-af8b-a599266ad8b1",
  "livemode": true
}

Payload fields (websalesConfig.updated)

Field Type Description
data._id string Websales config id (ObjectId)
data.accountId string Account id (ObjectId)
data.domain string Domain for the config
data.websales_bgcolor string Background color for websales
data.customCss string Custom CSS styles
data.socialSharing boolean Whether social sharing is enabled
data.fullpageLogoLink string Link for logo resource
data.fullpageHeadline string Fullpage headline text
data.fullpageInfoHeadline string Fullpage info headline text
data.fullpageInfoDetails string Fullpage info details text
data.waitingMessage string Waiting message text
data.websales_logoredirecturl string URL for logo redirect
data.disableBackButtonOnTripResults boolean Whether back button is disabled on trip results
data.forceLogin boolean Whether login is forced
data.sso object SSO config (enabled, cas array, only)
data.lexiconKeys object Lexicon keys (fullpageHeadline, fullpageInfoHeadline, fullpageInfoDetails, ssoErrorMsg)
data.userId string User id (ObjectId)
data.createdAt object Creation timestamp (value, offset)
data.updatedAt object Last update timestamp (value, offset)
data.createdBy string User id that created (ObjectId)
data.updatedBy string User id that last updated (ObjectId)
data.deleted boolean Whether the config is marked deleted

Payload example deleted

{
  "attemptId": "15b4cd65-a0bb-485e-997b-f244fec0ca20",
  "created": 1640621211,
  "data": {
    "accountId": "624e08b5fdd69a15e973fcbc",
    "domain": "deleteddomain"
  },
  "event": "websalesConfig.deleted",
  "id": "e0870b6e-d0ca-4edb-af8b-a599266ad8b1",
  "livemode": true
}

Payload fields (websalesConfig.deleted)

Field Type Description
data.accountId string Account id (ObjectId)
data.domain string Domain of the deleted websales config