Account Breached

Webhook: RuleBreached

Triggered when a user’s trading account violates one of the predefined program rules (e.g., daily drawdown, trailing daily drawdown, etc.). This webhook helps notify external system or internal teams for rule monitoring, user notifications, and enforcement actions such as account suspension.

{
  "webhookType"          : "RuleBreached",
  "testMode"             : false,
  "userId"               : "<user_id>",
  "userFirstname"        : "<user_firstname>",
  "userLastname"         : "<user_lastname>",
  "userEmail"            : "<user_email>",
  "userCountryCode"      : "<user_country>",
  "programId"            : "<program_id>",
  "programName"          : "<program_name>",
  "accountId"            : "<account_id>",
  "accountLogin"         : "<account_login>",
  "breachRuleValue"      : "<breach_rulename>",
  "breachReason"         : "{<breach_reason>}",
  "breachTimestamp"      : "<breach_timestamp>"
}

For breach reason, please check Breach Reason.

Payload Structure

Field	Type	Description
webhookType	String	Type of webhook event. Always RuleBreached for this webhook.
testMode	Boolean	Flag to indicate whether this payload is a test true or live false. Currently, only false is supported.
userId	String	Unique identifier for the user within YourPropFirm SaaS platform.
userFirstname	String	First name of the user.
userLastname	String	Last name of the user.
userEmail	String	Email address of the user, also the user unique identifier for authentication.
userCountryCode	String	ISO 3166-1 alpha-2 country code (e.g., US, SG, GB) of the user’s address.
programId	String	Unique identifier for the trading program or plan the user enrolled in.
programName	String	Display name of the trading program of the user joined.
accountId	String	Internal ID used to reference the created trading account.
accountLogin	String	Login ID or number for accessing the trading account on the platform.
breachRuleValue	String	Unique rule identifier within YourPropFirm SaaS Platform.
breachReason	Array	Array of detailed information of the violation. Please see the detail reason in here Breach Reason in Webhook - YourPropFirm SaaS Platform.
breachTimestamp	String	ISO 8601. Timestamp of when the breach occurred (e.g., 2025-04-29T12:30:00Z).