Automatically sync your existing recipients to your Axios HQ audience
Setting up a generic SFTP or SCIM connection allows you to connect your current email distribution lists and sync them to Axios HQ. As your email lists change you won't have to worry about updating your audience to match in Axios HQ. Updates will sync automatically.
⭐ Directory Sync with SFTP/SCIM requires an upgrade from the Essential Package.
Table of contents:
1. Overview
If your team has an existing directory, CRM, AMS or any other system that acts as your source of truth for recipients and recipient groups, Axios HQ offers generic/custom connections through an SFTP or SCIM integration.
We partner with WorkOS to facilitate this integration. You can find an introduction to WorkOS and their workflow here.
2. Setting up an SFTP sync
An SFTP setup allows your organization to synchronize user and group information by uploading CSV files at a regular, automatic cadence. Any system that can export the necessary CSV files can be connected via SFTP. This includes directories, Association Management Systems, or other databases.
WorkOS is set up to receive your directory setup request, automatically creating and hosting an SFTP folder for your organization’s data provider to upload files at a regular cadence.
🛠️ How it works
- As an HQ Admin/Owner, navigate to Settings > Integrations, then locate Direcory Sync and click "Connect."
- You will be taken to a setup portal provided by WorkOS.
- Select SFTP at the bottom right of the Select your provider screen
- Walk through the setup instructions that will appear on your screen. This will also include information on required fields for your csv files. You can view the users.csv and user_groups.csv file requirements here.
- When your directory sync is complete, you will see the linked connection at Settings > Integrations.
Your team is responsible for writing the script to export the required CSVs for this connection. WorkOS and Axios HQ are configured to accept the output of this code.
As long as you can hit the SFTP host with a public/private key and the username, you can make this connection. WorkOS is looking for a public key for authentication (which has to be provided by your team), WorkOS will provide the username and hosted endpoint.
Having trouble writing the script? Certain vendors can help with data activation and might even provide a free connection!
3. Setting up a Custom SCIM 2.0 connection
WorkOS is set up to receive requests from your source of truth as long as it has a SCIM server setup.
🛠️ How it works
- As an HQ Admin/Owner, navigate to Settings > Integrations, then locate Direcory Sync and click "Connect."
- You will be taken to a setup portal provided by WorkOS.
- Select Custom SCIM at the bottom left of the Select your provider screen
- Walk through the setup instructions that will appear on your screen. The setup will provide an endpoint for your SCIM server and a bearer token for authentication.
- When your directory sync is complete, you will see the linked connection at Settings > Integrations.
4. Attributes
By default Axios HQ syncs only a limited list of attributes coming from a SCIM/SFTP connection:
- first_name
- last_name
- any group assignments
If you would like to sync the following additional attributes, please reach out to help@axioshq.com and we will be able to turn this on for your team:
| job_title | department_name | raw_address | manager_email |
| employment_start_date | division_name | street_address | preferred_language |
| employee_type | cost_center_name | city | |
| region | |||
| postal_code | |||
| country |
5. FAQ
📚 Sending
Can I still send from HQ before setting up a directory sync?
Yes! You can still send from HQ before setting up a directory sync. You can manually add recipients by navigating to your series audience and either:
- Upload a CSV of multiple individuals by clicking on "Manage recipients" and selecting "Import CSV"
- Individually add new recipients by clicking on "Add individuals"
Can I use a CSV and my directory groups?
Yes! Add individuals one-by-one or via CSV at any time. If a CSV is uploaded or deleted, contacts added via Directory Sync will not be affected. If a recipient is on a CSV and synced via directory sync with the same email address, they will not receive an edition twice.
📚 Troubleshooting
My recipients aren't syncing / I see my recipient is listed as "Inactive"
📚 Access
Who can access my organization's synced directory?
Only Owners, Admins, and Members with granted permission can access your synced directory.
Will synced members (recipients) gain access to the platform?
No. Synced audience members (recipients) will not gain access to the platform. Access is only granted by inviting users to your organization and through our SSO integration.
📚 Sync
How often will syncs be performed?
- SCIM connections sync depend on the interval set by your directory provider.
- SFTP syncs will happen at a cadence set by your team.
We have multiple directories, how can we sync them?
Reach out to us at help@axioshq.com to set up an additional directory. Each organization is entitled to two directories without charge, and can add more connections for an additional fee.
If a directory member is removed from the SFTP upload/the SCIM group management, is that member automatically disabled / removed from the directory sync (audience)?
Yes, and this recipient will be removed from all audiences across all series within your organization. However, the users themselves will not be removed from the platform.
- If a member of the directory is also an HQ user, the connections must be viewed separately.
- User access will be revoked when a user is deprovisioned from the SAML app (ie: their account is deleted or marked inactive) but their username will still be visible as a collaborator; the user will simply no longer be able to login.
📚 Security
Can we review WorkOS's Privacy Policy?
Yes, check out WorkOS's Privacy Policy and Security FAQs here.