Connecting TNZ with REDCap

Use TNZ's SMS and Email modules to add messaging to your REDCap environment.

This guide outlines the installation process for REDCap administrators. Contact TNZ for the module scripts and installation assistance.

Before you start

Arrange access to your REDCap server, Control Center, and the project that will use the modules. Ask your REDCap administrator to handle installation if you do not manage the environment.

You also need a TNZ account and an Auth Token. Follow Generating your TNZ Auth Token before you configure the modules.

1. Prepare and install the modules

1. Obtain the TNZ SMS and/or TNZ Email module package from TNZ.
2. In each module's ExternalModule.php file, replace the [AUTH TOKEN] placeholder with your TNZ Auth Token.
3. Extract the configured modules into separate directories in your REDCap installation's modules directory.

Example directories are /modules/redcap-tnz-sms/ and /modules/redcap-tnz-email/. Follow the package instructions supplied by TNZ for your installation.

Keep the configured files private because they contain your Auth Token.

2. Enable the modules in Control Center

1. Open the REDCap Control Center.
2. Open External Modules.
3. Find and enable TNZ SMS and/or TNZ Email.

3. Enable the modules for your project

1. Open the REDCap project that will use TNZ.
2. Select External Modules from the project menu.
3. Enable TNZ SMS and/or TNZ Email for that project.
4. Configure the module settings for your project's messaging requirements.

Test before you use project messaging

Work with your REDCap administrator to test each enabled channel using a recipient you control. Check the destination and message content before you use participant details.

If a module does not appear, ask your administrator to check the installation directory and Control Center activation.

If authentication fails after you recycle your TNZ Auth Token, update the token in each configured module.

Contact TNZ for the module package, configuration guidance, or help with a failed test. Include the error text, but do not send your Auth Token or participant data.