How to integrate StopChurn

Learn how to connect StopChurn to B2CORE to sync client data and key client events for retention and CRM workflows

Use integration with StopChurn to automatically send client data and key client events from B2CORE to StopChurn, a client retention and CRM platform. StopChurn can then use this data to segment clients and run retention campaigns.

The integration supports one-way data transfer from B2CORE to StopChurn. B2CORE is the single source of truth: StopChurn only receives data, and nothing is read back from StopChurn into B2CORE.

Before you proceed, make sure you have access to the StopChurn Back Office and have received an API key and a Brand ID from StopChurn. If you have any questions, contact the StopChurn team.

Prepare StopChurn

Complete these steps in StopChurn before you enable the connection in B2CORE.

Check the contact table fields

In the StopChurn Back Office, go to Database > Table Definitions and open the user (contact) table. B2CORE fills in the following fields for each StopChurn contact:

Identity: ID, email, phone, first name, last name, birthday
Location and profile: country (name), country code, currency, jurisdiction, language, client type (individual or corporate), registration date, verification level
KYC: KYC status, KYC submission date, KYC approval date
Deposits: first and last deposit date and amount, total deposit amount, net deposit
Trading: first and last trade date, total number of trades, trading account opening date
Marketing attribution: UTM source, UTM medium, UTM campaign, affiliate ID
Marketing preferences (email and phone): turned off when the client has unsubscribed from marketing or hasn't given marketing consent
System preferences (email and phone): always turned on

Dates are sent as timestamps. The contact currency is always USD, and all deposit amounts on the contact are in USD.

Create custom events

B2CORE sends six custom events to StopChurn. Create each of them in Database > Table Definitions by clicking New Custom Event:

Name — must match the value in the table below exactly.
Label — any text you like.
Value type — required; must match the value in the table below.

Event	Name	Value type	Value
Registration completed	`REGISTRATION_COMPLETED`	`BOOLEAN`	Always `true`
Verification level changed	`VERIFICATION_LEVEL_CHANGED`	`NUMBER`	The client's new verification level
KYC approved	`KYC_APPROVED`	`BOOLEAN`	Always `true`
KYC rejected	`KYC_REJECTED`	`STRING`	The rejection reason (may be empty)
Deposit completed	`DEPOSIT_COMPLETED`	`JSON`	Deposit details (see Deposit event fields)
First deposit	`FIRST_DEPOSIT`	`JSON`	Deposit details (see Deposit event fields). Sent only for the client's first successful deposit

Create all six events before you enable the connection. If an event is missing in StopChurn or has the wrong value type, StopChurn rejects it, and the event is lost. Rejected events aren't sent again.

Deposit event fields

The Deposit completed and First deposit events contain the following fields:

amount — the deposit amount in the deposit currency.
currency — the deposit currency, for example, EUR.
amountInUSD — the deposit amount converted to USD at the exchange rate at the moment the deposit completed, rounded to 2 decimal places. Empty if B2CORE had no USD exchange rate for the deposit currency at that moment; the event is still sent.
paymentSystem — the name of the deposit method the client used, exactly as specified in the Name field of the method in System > Deposit system, for example, b2binpay_enterprise.

If you use the deposit event as a conversion goal in StopChurn, set amountInUSD as the goal value, so that all deposits are measured in one currency.

Give your deposit methods clear, stable names. If you rename a deposit method, StopChurn receives the new name for all future deposits made with it, so StopChurn segments and journeys filtered by the old name stop matching those deposits.

Configure a connection to StopChurn in the B2CORE Back Office

To configure a connection to StopChurn:

Navigate to System > External connections.

Click +Create in the upper-right page corner.

On the Create connection page, fill in the following fields:

In the Name field, enter a name for the connection. The name must be unique.
In the Caption field, enter a caption that will be applied to the connection in the Back Office.
In the Provider dropdown, select StopChurn.

Click Save to create the connection.

The StopChurn connection will appear in the list of external connections.

Click Edit to enter the connection details and complete the following fields:

Environment — select the StopChurn environment: Staging or Production.
API Key — enter the API key provided by StopChurn.
Brand ID — enter the ID of the StopChurn brand that receives the data.
User table name — optional. Leave empty to use the default StopChurn user table.
External ID strategy — select the value B2CORE uses as the contact ID in StopChurn:
- B2CORE Client ID (default)
- B2CORE Client Email
- Random UUIDv7
External ID prefix — optional text added in front of the contact ID. Allowed characters: letters, digits, and _ . : -; up to 32 characters. Use a prefix when several brands or B2CORE instances share one StopChurn account, so their contact IDs don't overlap.

Click Test connection to check that StopChurn accepts the API key. The test doesn't create or change any data in StopChurn.

Check the connection status.

If the connection is inactive (No is displayed in the Enabled field), activate it by setting the Enabled dropdown to Yes.

Click Save to apply the changes.

A client's contact ID in StopChurn is fixed the first time the client is sent. If you change the External ID strategy or External ID prefix later, the change applies only to clients that haven't been sent yet. Existing contacts keep their IDs, so StopChurn never receives duplicates.

You can enable several StopChurn connections at the same time, for example, one per StopChurn brand. Each enabled connection receives all client data and events.

To send your existing clients to StopChurn after you enable and test the connection, request an initial load.

Data sent to StopChurn

B2CORE sends data to StopChurn automatically. About one minute after any of the actions below, B2CORE sends the client's full, up-to-date contact record, together with the related events:

Action in B2CORE	Events sent
The client registers	Registration completed
The client's email, status, country, client type, verification level, or jurisdiction changes	—
The client's first name, last name, or birthday changes	—
The client's phone number changes	—
The client submits a verification application	Verification level changed
A verification application is approved	Verification level changed, KYC approved
A verification application is rejected	Verification level changed, KYC rejected (with the reason)
A deposit completes successfully	Deposit completed; also First deposit if it's the client's first successful deposit
The client unsubscribes from or resubscribes to marketing	—

Each send fully updates the contact in StopChurn, so sending the same client more than once is safe.

Initial load of all clients

Automatic sends cover only clients with new activity. To send all your existing clients to StopChurn, an initial load is required. If you need an initial load, contact the B2BROKER support team for assistance after you create and test the StopChurn connection.

Resync recently updated contacts

Use Resync Contacts to send StopChurn all clients whose profiles were updated in the last month. Run it to bring StopChurn up to date after a short outage or a misconfiguration.

Resync Contacts doesn't replace the initial load. Clients that weren't updated in the last month aren't included.

To resync recently updated contacts:

Navigate to System > External connections and open the StopChurn connection.

Click Actions > Resync Contacts.

A green message confirms that the resync has started. The resync runs in the background.

Keep in mind the following:

Resync Contacts is available only for enabled StopChurn connections, and only to Back Office users with the permission to update external connections.
You can run a resync once per hour per connection. If you click the button again within the hour, a message shows how many minutes you need to wait.
B2CORE doesn't run full resyncs automatically. Between resyncs, contacts stay up to date through the automatic sends.

Notes and limitations

The contact currency is always USD, and all deposit amounts on the contact are in USD. Deposit events include both the original amount and currency and the amount in USD (amountInUSD).
StopChurn's documentation doesn't describe where received events can be viewed. Check with the StopChurn team.

How to integrate StopChurn

On this page