Set Up Swell Integration

  • Published on Jan 30, 2025
  • 3 minute(s) read
REQUIRED USER ROLE 
Administrator
PERMISSION OVERVIEW
View permissions by role

Before you start

Review the following information before you connect Swell to Gladly.

  • This is a three-part configuration process that must be done in sequential order. Contact Gladly Support to add Customer attributes, log into Swell to copy your secret key, and then connect Swell to Gladly.

Contact Gladly Support to add customer attributes

Contact Gladly Support and ask to add the following attributes for the Swell integration.

  • Credit Balance

  • Total Spent

  • Average Order

These attributes appear as part of the Customer details that can be used to enhance routing logic using Rules or People Match.

User profile showing credit balance, total spent, and average order amount.

Once the attributes are added, proceed to find your secret key.

Find your secret key

  1. Log into your Swell store account.

  2. Click Admin, then Settings.

  3. From the Settings page, click API.

  4. At the top of the page, copy the Store ID.

  5. Under one of the secret keys, click on the eye icon to make the key visible.

  6. Copy the secret key.

Next, connect Swell to Gladly, where you must enter the secret key.

Connect Swell to Gladly

From the Apps page, click Add App > Custom.

  1. From the Add New Custom App page, enter the following information:

    • Name – Enter a name that will help you identify the integration. We recommend using "Swell.

    • URL – Enter https://swell.store/integration/api/gladly/lookup.

    • Username – Enter your Swell store name.

    • Password – Enter your Swell secret key.

    • Realm (Optional) – Leave this field blank.

    • Signing Key – This is the key used to sign each request Gladly makes to your lookup service. Enter eCkyYJCCFVoaAXoBTEXKBrf0nyhmJq2hOehxakz17ZA

    • Search Query Attributes – These attributes can be used to search for a Customer. There are two columns (Attribute, Label) required for Search Query Attributes. Enter the following as shown below.

      • Note – Searching by name and phone number works only for verified Customers only, and not guests.

Header

Value

email

Email

name

Name

first_name

First Name

last_name

Last Name

externalCustomerId

External Customer ID

  • Search Results Attributes – These attributes appear when linking a Customer to an external system like Swell. There are two columns (Attribute, Label) required for Search Results Attributes. Enter the following as shown below. HeaderValueemailEmailnameNameexternalCustomerIdExternal Customer IDphonePhone

  • Auto-Linking Fields –If a Customer Profile is not currently linked to a Swell instance, and if your Swell instance responds with a unique profile with at least one auto-linking field match and no conflicts, Gladly will automatically link the profiles without any user intervention and populate the pulled information in the Customer Profile.

    • Check the box next to Customer Email. Auto-linking by phone/Phone Number attribute is currently not supported.

  • Overwrite Existing Values – As an optional setting, if activated, when a Customer Profile is linked to a profile in Swell, Gladly will overwrite the existing name, address, and editable custom attributes in the Customer Profile in Gladly with data from Swell.

  • Enable Actions - Do not check this box as Actions is not supported.

Click Save App when you're done. If the required fields are not completed, an error will appear; they are highlighted in red. Complete the missing fields and click Save App again.

Related docs