Rms settings

RMS settings

RMS (Revenue Management System) settings webhooks are emitted by the Accounts API when revenue management (Ratality) integration is enabled or disabled via PUT /rms-settings.

Events

Action Event name
enable RMS (PUT /rms-settings with enabled: true) rms.enabled
disable RMS (PUT /rms-settings with enabled: false) rms.disabled

Payload example (rms.enabled / rms.disabled)

The data field contains the full revenue management settings object (same shape as the API response body revenueManagementSettings).

{
  "providerId": "5f243d100617680712e78dd7",
  "apiKey": "string",
  "data": {
    "enabled": true,
    "applicationId": "5f243d100617680712e78dd7",
    "subscriptionId": "string",
    "ratalityClientId": "string",
    "userId": "string"
  }
}

Payload fields (rms.enabled / rms.disabled)

Field Type Description
providerId string Account ID of the provider (24-character hex ObjectId)
apiKey string API key used for the request (X-API-KEY header)
data object The revenue management settings document. Same shape as GET /rms-settings and PUT /rms-settings response revenueManagementSettings; includes enabled, applicationId, subscriptionId, ratalityClientId, userId