Setup
Adding the integration
To add a Tessitura integration to your Action Links account, you'll need to set up a user with the relevant permissions to access the API, and if you're using TNEW, get the encryption details from your TNEW admin account.
| Field | Details |
|---|---|
Tessitura Version | Action Links has support for both Tessitura v15 and v16. You can add a separate integration for each while testing before you upgrade, or if your user credentials are the same, toggle an existing integration from v15 to v16 when you're ready. |
API URL | The URL for your Tessitura API instance. If you don't know this, you can request this from Tessitura's support team. |
User ID | The ID for the User you've created (see below). |
User Password | The password for the User you've created (see below). |
User Group ID | The ID for the User Group the User belongs to (see below). |
Machine Location Name | The name value for the Machine Location in TX_MACHINE_LOCATION (see below). |
TNEW | If true, Action Links will display additional fields that are required to facilitate session sharing with TNEW (see below). |
Troubleshooting issues
If there's an issue with your Tessitura integration setup, when you create and access a Link that uses that integration an error will be recorded against the Link. Links with errors will be flagged on the My Links page, and you can view the error itself at the top of the edit page for the Link.
If the error suggests that there's a problem with your API credentials, check that the User is not locked, and that the password hasn't changed, the User Group its assigned to has the correct permissions, and that the User must change password at next login is NOT checked.
TNEW settings
These settings are specific to organisations who are using TNEW and have checked the TNEW field in the integration options.
| Field | Details |
|---|---|
TNEW URL | The URL for your TNEW site. Make sure to include the protocol at the start ( |
Anonymous user Constituent ID | The Constituent ID of your anonymous user. This is the user that TNEW assigns sessions to where the actual user has not yet logged in. If you're not sure what the Constituent ID of your anonymous user is, get in touch with Tessitura Support. |
Encryption Passphrase | You can find this by logging in to the TNEW admin panel and going to Site Setup -> Session Sharing. |
Encryption Salt | You can find this by logging in to the TNEW admin panel and going to Site Setup -> Session Sharing. |
Encryption Authentication Key / HMAC | You can find this by logging in to the TNEW admin panel and going to Site Setup -> Session Sharing. |
Setup in Tessitura
Action Links connects to Tessitura via the Tessitura API using an Authentication String. This Authentication String is generated by combining and encoding several pieces of information that can all be found in the Tessitura application:
The ID and Password of a User
The ID of a User Group associated with the User
The Name of a Machine Location
Before you can add a Tessitura integration to your Action Links account, you'll need to do the following:
Create a User for the API
Configure a User Group (if a relevant Group doesn't already exist)
Assign the User Group to your User
Create a Machine Location (or choose an existing one)
This documentation is applicable to both Tessitura v15 and v16
Note that the links and screenshots in this documentation are from the Tessitura v15 application, but the principles are the same for both versions. Action Links works with both Tessitura v15 and v16.
1. Create an API user
The first step is to create a User for the API to use. This user is much the same as a regular user account – it can be helpful to think about the integration as its own user, updating customer records and processing orders via the API in the same way as you might via the Tessitura application. Any updates that Action Links makes to the data in Tessitura will display as having been made by this User.
You can create an API user from the Tessitura Security application. Open the Maintain Users screen and click the New button.
The Add User window will open. When creating the User, choose the API option from the Type dropdown. Keep a note of the User ID and Application Password – you'll need to provide these when adding the integration to your Action Links account. Complete the required fields (making sure User must change password at next login is NOT checked) and click OK.
2. Configure a User Group
User Groups are used to restrict what your API user (and in this case, Action Links) can do via the Tessitura API. It's advisable to create a new User Group for Action Links to avoid future permission changes inadvertently preventing your Links from working.
From the Maintain User Groups screen, click New.
Complete the required fields. Keep a note of the Group ID – you'll need to provide this when adding the integration to your Action Links account.
Make sure you give your API user the permissions it needs
User Groups (consisting of User Group Organizations and Control Groups) are used to determine what an API user can and can't do in the same way as a regular user.
Action Links only requires the minimum permissions necessary for your Links to work. However, incorrectly configured User Groups are the most likely cause when your Action Links are unable to connect and/or make requests to the Tessitura API.
3. Assign the User Group to your User
Next, you need to assign the User Group you just created to your User. From the Maintain Users screen, select the API user you just created and click the Groups button. Select the User Group you created in the previous step and click the arrow to move the Group from the left pane to the Associated pane on the right. Check the Default checkbox and click OK.
4. Create a Machine Location (or choose an existing one)
Finally, open the System Tables screen and select the TX_MACHINE_LOCATION table from the sidebar (if you can't see this table, you may not have the relevant permissions to access it). Add a new row or choose an existing Location and note down the Machine Name – you'll need to provide this when adding the integration to your Action Links account.
Making sure your Action Links are secure
We use industry standard security to integrate with your other systems, including multiple levels of encryption, and ensuring that your authentication keys are never exposed to a user's browser.
Read more about how we ensure your integrations are secure ->
Last updated
