Documentation

Find documentation for our Joomla extensions on this page.

JoomCRM - SwiftDigital Integration

JoomCRM connects with SwiftDigital so you can manage your email mailing lists without leaving the CRM. With this integration you can:

  • See all your SwiftDigital mailing lists inside JoomCRM
  • Add or remove persons and companies from mailing lists with one click
  • Automatically add new contacts to mailing lists when they are created

Before You Start

You will need:

  • Admin access to your Joomla website
  • A SwiftDigital Suite account
  • About 10 minutes to complete the setup

Step 1: Get Your API Credentials from SwiftDigital

You need three pieces of information from your SwiftDigital account.

  1. Log in to your SwiftDigital Suite admin panel
  2. Go to Administration > Integrations > REST API v3
  3. Click Add OAuth 2.0 API Client
  4. Copy and save these three values somewhere safe:
What to copyWhere to find it
Client ID Shown after creating the API client
Client Secret Shown only once when the client is created -- copy it right away
T3 Account ID Shown after the API client is added

Warning: The Client Secret is only shown once. If you lose it, you will need to create a new API client in SwiftDigital.


Step 2: Connect JoomCRM to SwiftDigital

  1. In your Joomla admin panel, go to Components > JoomCRM > Configuration
  2. Scroll down to the Mailing Lists section
  3. Set Mailing List Integration to swiftdigital
  4. Fill in the three fields that appear:
    • Client ID -- paste the Client ID you copied
    • Client Secret -- paste the Client Secret you copied
    • Account ID -- paste the T3 Account ID you copied
  5. Click Save

You can also choose whether mailing lists are available on person records, company records, or both:

  • Enable People Mailing Lists -- set to Yes to manage lists on person records
  • Enable Company Mailing Lists -- set to Yes to manage lists on company records

Step 3: Check That It Works

  1. Open any person record that has an email address
  2. Click Manage Mailing Lists
  3. You should see your SwiftDigital mailing groups listed in the popup

If the list appears, the connection is working.


How to Add or Remove Someone from a Mailing List

Adding to a list

  1. Open a person or company record
  2. Click Manage Mailing Lists
  3. You will see all your SwiftDigital groups with an Add button next to each one
  4. Click Add next to the group you want -- a success message will appear

Removing from a list

  1. Open the same person or company record
  2. Click Manage Mailing Lists
  3. Groups the contact is already subscribed to will show a Remove button
  4. Click Remove to unsubscribe them

Automatic Subscriptions (Optional)

You can set up JoomCRM to automatically add new contacts to your mailing lists whenever a person is created. This works for contacts added through the CRM interface, CSV imports, and form submissions.

Setting it up

Part A -- the plugin:

  1. Go to Extensions > Plugins, search for "SwiftDigital", and make sure the plugin is Enabled

Part B -- Turn on auto-subscribe:

  1. Go to Components > JoomCRM > Configuration
  2. In the Mailing Lists section, set Auto-subscribe new contacts to Yes
  3. In the Default Group IDs field, enter the SwiftDigital group numbers you want new contacts added to, separated by commas (for example: 123,456)
  4. Click Save

How to find your Group IDs

  1. Open any person record in JoomCRM
  2. Click Manage Mailing Lists
  3. Each mailing group has an ID number -- note down the ones you want
  4. You can also find group IDs in your SwiftDigital admin panel under the mailing groups section

What happens when a new person is created

When someone creates a new person in JoomCRM:

  1. The system checks if the person has an email address
  2. If auto-subscribe is turned on and group IDs are configured, the person is automatically added to those SwiftDigital mailing lists
  3. Their name, email, phone, country, and company are sent to SwiftDigital
  4. You will see a log entry confirming the subscription

Note: Auto-subscribe only runs when a person is first created, not when an existing record is updated.


Troubleshooting

"Empty API details" error

Your credentials are missing or incomplete. Go to Components > JoomCRM > Configuration and make sure all three fields (Client ID, Client Secret, Account ID) are filled in.

"Invalid API Response" error

Your server cannot connect to SwiftDigital. Ask your hosting provider to confirm that outgoing connections to v3.api.swiftdigital.com.au on port 443 are allowed.

No mailing lists appear

  • Double-check that your API credentials are correct
  • Make sure you have at least one mailing group created in your SwiftDigital account
  • Try saving the JoomCRM configuration again to refresh the connection

Auto-subscribe is not working

Check all of the following:

  1. The JoomCRM - SwiftDigital Auto Subscribe plugin is enabled (check in Extensions > Plugins)
  2. Auto-subscribe new contacts is set to Yes in JoomCRM Configuration
  3. Default Group IDs has at least one valid group ID
  4. The new person has an email address

How to check error logs

  • On-screen messages: Errors appear as red banners in the Joomla admin when you interact with mailing lists
  • Log files: Go to System > Global Configuration > Logging to enable logging, then check the log files in your site's administrator/logs/ folder

How to reset the connection

If the integration stops working after a credentials change:

  1. Go to Components > JoomCRM > Configuration
  2. Clear the Client ID field and click Save
  3. Re-enter the Client ID and click Save again

This forces the system to create a fresh connection with SwiftDigital.


Migrating from the Previous Version

If you were using the older version of this integration (before the v3 update), follow these steps to switch over.

What changed

SwiftDigital retired their old API and replaced it with a new one. The old login credentials (Username, Password, Consumer Key) no longer work. You need new credentials from SwiftDigital.

How to migrate

1. Get new credentials

  1. Log in to your SwiftDigital Suite admin panel
  2. Go to Administration > Integrations > REST API v3
  3. Create a new OAuth 2.0 API Client
  4. Copy the Client ID, Client Secret, and T3 Account ID

Your old Username and Password will not work with the new system.

2. Update your JoomCRM settings

  1. Go to Components > JoomCRM > Configuration
  2. The old fields (Username, Password, Consumer Key, API Call Source, Publication URL) have been replaced with new ones
  3. Enter your new credentials:
    • Client ID
    • Client Secret
    • Account ID (t3acctid)
  4. Click Save

3. Test the connection

  1. Open a person record with an email address
  2. Click Manage Mailing Lists
  3. Confirm your SwiftDigital groups appear
  4. Try adding and removing a contact from a list to make sure everything works

4. Set up auto-subscribe (optional)

This is a new feature that was not available before. If you want new contacts to be automatically added to mailing lists, follow the Automatic Subscriptions instructions above.

What was removed

These old settings are no longer needed and have been removed from the configuration:

Old settingWhat replaced it
Username Client ID
Password Client Secret
Consumer Key No longer needed
API Call Source No longer needed
Publication URL No longer needed

What was added

New settingWhat it does
Client ID Your new SwiftDigital API login
Client Secret Your new SwiftDigital API password
Auto-subscribe new contacts Automatically add new persons to mailing lists
Default Group IDs Which mailing lists to auto-subscribe to

Bug fixes included

This update also fixes several issues that may have affected you:

  • Subscribe errors -- subscribing a contact to a list could fail silently without showing an error message. Errors are now shown clearly.
  • Slow mailing list loading -- opening the "Manage Mailing Lists" popup was slow because it checked every group individually. It now loads much faster with a single check.
  • Unsubscribe always showed success -- removing a contact from a list always said it succeeded, even if it failed. It now shows the actual result.

Quick Reference

TaskWhere to go
Set up the integration Components > JoomCRM > Configuration > Mailing Lists
Add/remove someone from a list Open person/company record > Manage Mailing Lists
Install auto-subscribe plugin Extensions > Manage > Discover
Enable/disable auto-subscribe Components > JoomCRM > Configuration > Auto-subscribe new contacts
Check for errors Look for red messages on screen, or check System > Global Configuration > Logging
Get new API credentials SwiftDigital Suite > Administration > Integrations > REST API v3
Cron Job Starts

We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience (tracking cookies). You can decide for yourself whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.

Ok