You can connect any e-commerce backend to Rokt Catalog using the Partner and Brand APIs. The API is ideal for custom-built stores, headless platforms, or any setup where the Shopify, WooCommerce, or BigCommerce apps aren't a fit. This guide walks you through registering your account, locating your API keys, and subscribing to webhooks.
Before you start
- Review the Catalog API documentation. There are separate docs for Partner and Brand functionality — you can implement one or both.
- If you have a development or staging environment, sign up your dev store on a separate account. For example, use
john.smith@myshop.comfor production andjohn.smith+dev@myshop.comfor your dev store.
Other integration options
The API isn't the only way to connect. Depending on your platform, you may prefer one of these alternatives:
- Shopify: Install the Rokt Catalog app from the Shopify App Store — no code required.
- WooCommerce: Follow the WooCommerce onboarding guide.
- BigCommerce: Follow the BigCommerce onboarding guide.
- Web SDK or native SDKs: Rokt offers a lightweight Web SDK and native SDKs for iOS, Android, Flutter, and React Native. These are typically used for advanced integrations where Catalog products appear within the Rokt ecosystem (like Aftersell or Thanks placements).
- Tag managers: You can integrate via Google Tag Manager if your site already uses it.
Register your account
- Go to the Catalog signup portal and create your account.
- When prompted to choose your platform, select the API option. If you select I already have a Shopify account, you'll be redirected to Shopify to link your store instead.
- Choose whether you're signing up as a Partner or a Brand. You need to select one to get started, but you can register the other role to your account later.
- Complete the onboarding steps that follow. Catalog's AI-powered onboarding automates most of the product data mapping, so you can expect to be live in days rather than weeks.
Find your API keys
- After onboarding, select your profile icon in the upper-right corner and go to Settings.
- Select the Developer tab to view your API keys.
Keep your API keys secure. Do not share them publicly or include them in client-side code.
Subscribe to and test webhooks
Webhooks notify your system in real time when events happen in Catalog — like a new order, a proposal status change, or an inventory update.
- From the Developer tab, select Add webhooks.
- Choose the type of webhook you'd like to add.
- After adding the webhook, select Run Test to send test data and confirm everything is flowing correctly.
What success looks like
You should now have your API keys and at least one active webhook subscription in the Developer tab. From here, you're ready to start building your integration using the API documentation.
If you run into any issues, reach out to roktcatalogsupport@rokt.com.