Once you have confirmed that the source platform supports sending events to ProfitWell, follow the steps below:
From your RudderStack dashboard, add the source. From the list of destinations, select ProfitWell.
Assign a name to the destination, and click Next. You will then see the following Connection Settings window:
Connection Settings
To successfully configure ProfitWell as a Cloud Mode destination, enter the following connection settings:
Private API Key: Enter your ProfitWell private API key here. To obtain the Private API Key, log into your ProfitWell account. Then, navigate to the Account Settings - Integration option. Here, you can get your API key under API Keys/Dev Kit, as shown in the following image:
To send events to ProfitWell via cloud mode, you don’t need to enter the Public API Key.
Finally, click Next to complete the setup. ProfitWell should now be configured and enabled as a destination in RudderStack.
Identify
The identify call lets you create or update a subscription for a particular user.
RudderStack passes the fields profitwellUserId and profitwellSubscriptionId as externalId.
Note that:
The externalId of type profitwellUserId is mapped to ProfitWell’s user_id field.
The externalId of type profitwellSubscriptionId is mapped to ProfitWell’s subscription_id field.
Identify Mapping
This section lists the various criteria for mapping RudderStack fields to ProfitWell fields.
The following table lists all supported fields for Creating Subscriptions with their relative mapping to the ProfitWell fields:
RudderStack Field
ProfitWell Field
userId
user_alias
subscriptionAlias
subscription_alias
email
email
planId
plan_id
planInterval
plan_interval
planCurrency
plan_currency
status
status
value
value
effectiveDate
effective_date
The following table lists all supported fields for Updating Subscriptions with their relative mapping to the ProfitWell fields:
RudderStack Field
ProfitWell Field
planId
plan_id
planInterval
plan_interval
value
value
status
status
effectiveDate
effective_date
While creating a subscription, if effectiveDate is not provided in the identify call, then RudderStack takes the date from the event call’s timestamp/originalTimestamp.
RudderStack discards the identify event in the following two scenarios:
For a given profitwellUserId, a user account is not found in ProfitWell.
For a given profitWellUserId, a profitwellSubscriptionId is not found.
If you provide a userId(mapped to user_alias in ProfitWell) or a subscriptionAlias (mapped to subscription_alias) in the identify call, a new user subscription is created if it is not already present.
FAQ
Where do I get the API Key for ProfitWell?
To obtain your ProfitWell Private API Key, log into your ProfitWell dashboard. Navigate to the Account Settings - Integration option. Here, you can get your API key under API Keys/Dev Kit, as shown in the following image:
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.