Create Reward Event Configuration

The CFX Rewards Engine supports the automation of reward issuance based off certain CFX Network events. These can be configured to ensure Identities are issued rewards as they perform specific network activities. For example:

• Issue a $50 signup reward bonus
• Issue a $5 reward for completing KYC
• Issue a $1 reward for completing a deposit

Events

The following events are currently supported:

• deposit.cryptoRequest.statusUpdated: The status of a crypto deposit quote has changed
• deposit.usWireRequest.statusUpdated: The status of a US wire quote has changed
• deposit.deposit.statusUpdated: The status of a deposit has changed
• identity.identity.statusUpdated: The status of an identity has changed
• identity.identityVerification.statusUpdated: The status of an identity verification process has changed
• organization.organization.statusUpdated: The status of an organization has changed
• reward.reward.claimed: THe status of a reward claim has changed
• reward.reward.created: A reward has been created
• swap.swap.statusUpdated: The status of a swap between currencies has changed
• withdrawal.withdrawal.statusUpdated: The status of a withdrawal has changed
• send.send.statusUpdated: The status of a fund transfer has changed
• user.register.statusUpdated: The status of a CFX wallet has changed

Please see our WebHook Guide for details on the data structures for each event.

Event Rules

One or more rules can be configured for each event. When the event fires, the first matching rule, in order, will be triggered.

Rules are configured by specifying:

• The status of the rule (ACTIVE or DISABLED)
• The event the rule is triggered by
• An array of reward rules to apply when the event occurs, which each specify a reward amount, currency and a matcher to filter the event more specifically.

The matcher configuration lets you refine the filtering for each event. Matcher qeuries are defined similar to MongoDB query language. For example:

• "matcher":{"countryOfResidence":"US"}
• "matcher":{"amount":{"$gte":10}}

Please reach out to support for more information on how to use this feature.