Cratejoy API Key

Article summary

Did you find this summary helpful?

Thank you for your feedback

What does the API Key do?

Adding your Cratejoy API key to the RetentionEngine Builder is the first step to connecting RetentionEngine to your Cratejoy store.

The API Key allows the RetentionEngine to automatically update customer accounts with discounts, pauses, or cancellations.

Please note: RetentionEngine only works for customers that manage their account on your website.

Your Cratejoy marketplace customers will not cancel through the RetentionEngine.

On the sidebar menu, navigate "Platform Settings" and select "API."

Cratejoy Dashboard API Key.png

On the API screen, select the "Generate A New Key" button.

Cratejoy Generate New Key.png

You'll then see a pop up with the Client ID and Client Secret Key fields for your newly created API Key.

Cratejoy API Key fields

We will now return to the RetentionEngine builder and paste the Client ID and Client Secret ID into the corresponding fields.

Select Cratejoy as your billing system integration and paste the Client ID and Client Secret ID into the corresponding fields.

RE Builder Select Cratejoy.png

API Key Fields in RE Builder

Once those fields are pasted, you're API Key has been added, and you can continue to the RetentionEngine Dashboard!

proceed to dash

Was this article helpful?

Table of contents