# Ubiquity Docs

## Getting Started

- [Getting started with Ubiquity](https://docs.ubiquity.co.nz/readme.md): Get set up, learn the platform, and send your first campaign.
- [Platform overview](https://docs.ubiquity.co.nz/platform-overview.md): Learn how Ubiquity works and how everything fits together.
- [Onboarding checklist](https://docs.ubiquity.co.nz/onboarding-checklist.md): Follow the steps to get set up and ready to send.
- [Your first campaign](https://docs.ubiquity.co.nz/your-first-campaign.md): A step-by-step guide to creating and sending your first email campaign in UbiQuity.
- [User management](https://docs.ubiquity.co.nz/user-management.md): Manage users and control account access.
- [Account configuration](https://docs.ubiquity.co.nz/account-configuration.md): Settings and configuration options for your UbiQuity account. Most of these are managed by account admins or the UbiQuity team.
- [Acceptable use policy](https://docs.ubiquity.co.nz/acceptable-use-policy.md): Guidelines for using UbiQuity responsibly, including permitted use and prohibited activities.
- [Access and authentication](https://docs.ubiquity.co.nz/access-and-authentication.md): Manage user access and authentication to keep your UbiQuity account secure.
- [Security and trust](https://docs.ubiquity.co.nz/security-and-trust.md): Overview of UbiQuity’s approach to security.
- [Privacy policy](https://docs.ubiquity.co.nz/privacy-policy.md): Learn how your data is handled and protected.
- [Service levels](https://docs.ubiquity.co.nz/service-levels.md): How UbiQuity monitors the platform and prioritises incidents.
- [Data backup and recovery](https://docs.ubiquity.co.nz/data-backup-and-recovery.md): How UbiQuity protects your data and ensures it can be recovered in the event of an outage.
- [Contact us](https://docs.ubiquity.co.nz/contact-us.md): Get help from the UbiQuity support team by email or live chat.

## Documentation

- [Documentation overview](https://docs.ubiquity.co.nz/documentation/readme.md): Browse the platform by topic or find step-by-step guides for common tasks.
- [Content & Preview](https://docs.ubiquity.co.nz/documentation/basics/content-and-preview.md): Add and preview your content before sending, across email, TXT, and push.
- [Media Manager](https://docs.ubiquity.co.nz/documentation/basics/media-manager.md): Store, organise, and manage images and files used across your emails, landing pages, forms, and other content in UbiQuity.
- [Filtering](https://docs.ubiquity.co.nz/documentation/basics/filtering.md): Filter your audience to make sure the right contacts receive the right communications, across every part of the UbiQuity platform.
- [Channels](https://docs.ubiquity.co.nz/documentation/basics/channels.md): Understand the different ways UbiQuity can send messages to your audience, and choose the right channel for your campaign.
- [Templates](https://docs.ubiquity.co.nz/documentation/basics/templates.md): Create and manage reusable templates to speed up campaign creation and ensure consistency.
- [Access](https://docs.ubiquity.co.nz/documentation/basics/access.md): How to log into UbiQuity
- [Creating an email/form/survey/event/TXT](https://docs.ubiquity.co.nz/documentation/how-to/creating-an-email-form-survey-event-txt.md): Find the right starting point for creating mailouts, TXT outs, push notifications, forms, surveys, and events in UbiQuity.
- [Importing data](https://docs.ubiquity.co.nz/documentation/how-to/importing-data.md): Get your contacts and data into UbiQuity quickly using a CSV file - no technical setup required.
- [Sending an email](https://docs.ubiquity.co.nz/documentation/how-to/sending-an-email.md): Build, test, and send email campaigns with confidence, including key checks before sending.
- [Activate](https://docs.ubiquity.co.nz/documentation/how-to/activate.md): Set up and manage automated or triggered communications based on customer behaviour.
- [Email](https://docs.ubiquity.co.nz/documentation/channels/email.md): Create, manage, and send email campaigns, including design, personalisation, and tracking.
- [First Time Setup](https://docs.ubiquity.co.nz/documentation/channels/email/first-time-setup.md): Configure your UbiQuity account before sending your first email.
- [Email Templates](https://docs.ubiquity.co.nz/documentation/channels/email/email-templates.md): Build and manage email templates using UbiQuity's EasyEdit template system.
- [Default Template](https://docs.ubiquity.co.nz/documentation/channels/email/email-templates/default-template.md): An introduction to the default template.
- [Field Types](https://docs.ubiquity.co.nz/documentation/channels/email/email-templates/field-types.md): A breakdown of the field types in the default template.
- [Base Settings](https://docs.ubiquity.co.nz/documentation/channels/email/email-templates/base-settings.md): The settings available within the template.
- [Article Blocks](https://docs.ubiquity.co.nz/documentation/channels/email/email-templates/article-blocks.md): Understanding the options in article blocks.
- [Layout Breakdown](https://docs.ubiquity.co.nz/documentation/channels/email/email-templates/layout-breakdown.md): A breakdown of the different fields/tabs.
- [Mailout Folders](https://docs.ubiquity.co.nz/documentation/channels/email/mailout-folders.md): Organise your mailouts into folders, apply folder-level filters, and run reports across multiple mailouts.
- [Creating a Mailout](https://docs.ubiquity.co.nz/documentation/channels/email/creating-a-mailout.md): Create and send a one-off email mailout to your database contacts.
- [Creating an Automated Mailout](https://docs.ubiquity.co.nz/documentation/channels/email/creating-an-automated-mailout.md): Set up mailouts that send automatically on a recurring schedule based on dates or contact data.
- [Transactional Targeted Mailouts](https://docs.ubiquity.co.nz/documentation/channels/email/transactional-targeted-mailouts.md): Send emails driven by records in your transactional database rather than your contacts database.
- [Service Messaging](https://docs.ubiquity.co.nz/documentation/channels/email/service-messaging.md): Send critical service communications to contacts even if they have opted out of marketing emails.
- [Advanced Scheduling](https://docs.ubiquity.co.nz/documentation/channels/email/advanced-scheduling.md): Schedule emails based on external events or individual contact date and time fields.
- [A/B Subject Testing](https://docs.ubiquity.co.nz/documentation/channels/email/a-b-subject-testing.md): Test two subject lines against each other to find the most effective one for your audience.
- [Mailout Reports](https://docs.ubiquity.co.nz/documentation/channels/email/mailout-reports.md): View and interpret the performance data for your mailouts.
- [Email Delivery and Statuses](https://docs.ubiquity.co.nz/documentation/channels/email/email-delivery-and-statuses.md): Understand how UbiQuity delivers emails and what each message status means.
- [Building Optimised Emails](https://docs.ubiquity.co.nz/documentation/channels/email/building-optimised-emails.md): Best practices for creating emails that display correctly across devices and email clients.
- [Interactive Emails](https://docs.ubiquity.co.nz/documentation/channels/email/interactive-emails.md): Add interactive elements to your email campaigns to increase engagement.
- [TXT](https://docs.ubiquity.co.nz/documentation/channels/txt.md): Send targeted TXT messages to your contacts directly from UbiQuity — from simple one-off sends to multi-step automated programmes.
- [TXT Message Guidelines](https://docs.ubiquity.co.nz/documentation/channels/txt/txt-message-guidelines.md): Understand the compliance requirements for sending TXT messages in New Zealand.
- [TXT Concepts](https://docs.ubiquity.co.nz/documentation/channels/txt/txt-concepts.md): Understand the key concepts behind UbiQuity TXT before setting up your programmes and sends.
- [TXT Programmes](https://docs.ubiquity.co.nz/documentation/channels/txt/txt-programmes.md): Set up and build TXT programmes to handle inbound messages and send TXT Outs to your database.
- [Creating a TXT Out](https://docs.ubiquity.co.nz/documentation/channels/txt/creating-a-txt-out.md): Create and send a one-off TXT message to contacts in your UbiQuity database.
- [Creating an Automated TXT Out](https://docs.ubiquity.co.nz/documentation/channels/txt/creating-an-automated-txt-out.md): Set up TXT Outs that send automatically on a recurring schedule, triggered by date-based conditions in your contact data.
- [View Messages](https://docs.ubiquity.co.nz/documentation/channels/txt/view-messages.md): View all inbound and outbound TXT messages for your UbiQuity account and understand delivery statuses.
- [Push](https://docs.ubiquity.co.nz/documentation/channels/push.md): Send targeted push notifications to your mobile app users directly from UbiQuity.
- [Apps](https://docs.ubiquity.co.nz/documentation/channels/push/apps.md): Register and manage your mobile apps in UbiQuity before sending push notifications.
- [Connecting Your App](https://docs.ubiquity.co.nz/documentation/channels/push/connecting-your-app.md): A developer guide for integrating your mobile app with the UbiQuity API to enable push notifications.
- [Notification Templates](https://docs.ubiquity.co.nz/documentation/channels/push/notification-templates.md): Create and manage reusable templates to save time when building push notifications.
- [Creating a Notification](https://docs.ubiquity.co.nz/documentation/channels/push/creating-a-notification.md): Create, schedule, and send a push notification to your app users.
- [Creating an Automated Notification](https://docs.ubiquity.co.nz/documentation/channels/push/creating-an-automated-notification.md): Set up push notifications that send automatically based on a schedule or date-based triggers.
- [Finding your form/survey/event data](https://docs.ubiquity.co.nz/documentation/data-capture/finding-your-form-survey-event-data.md): Forms, surveys, and events each store data differently in UbiQuity. This page explains where to find what you are looking for.
- [Forms](https://docs.ubiquity.co.nz/documentation/data-capture/forms.md): Forms let you capture data directly into your UbiQuity database, giving you a simple way to grow your contact list, collect information, and trigger automated follow-up emails.
- [Creating a Form](https://docs.ubiquity.co.nz/documentation/data-capture/forms/creating-a-form.md): Creating a form in UbiQuity takes just a few steps. Before you start, make sure your database fields are set up, as these are what your form will pull from.
- [Settings](https://docs.ubiquity.co.nz/documentation/data-capture/forms/settings.md)
- [Fields and Validation](https://docs.ubiquity.co.nz/documentation/data-capture/forms/fields-and-validation.md): This is where you build your form, choose which database fields appear, set validation rules, and configure how the form behaves.
- [Confirmation Message](https://docs.ubiquity.co.nz/documentation/data-capture/forms/confirmation-message.md): To edit the confirmation page, go to the Form Dashboard and click Edit Confirmation Message.
- [Triggered Emails](https://docs.ubiquity.co.nz/documentation/data-capture/forms/triggered-emails.md): Triggered emails are sent automatically when a form is submitted. You can send them to the person who filled in the form, to someone on your team, or both.
- [Deploying Your Form](https://docs.ubiquity.co.nz/documentation/data-capture/forms/deploying-your-form.md): Every form has a unique URL. How you share that URL depends on the form type and where you want people to access it.
- [Form reports](https://docs.ubiquity.co.nz/documentation/data-capture/forms/form-reports.md)
- [Transactional Forms](https://docs.ubiquity.co.nz/documentation/data-capture/forms/transactional-forms.md): If you are using transactional data in UbiQuity, you can add transactional fields to your forms, allowing contacts to submit transaction records at the same time as their contact details.
- [Surveys](https://docs.ubiquity.co.nz/documentation/data-capture/surveys.md): Surveys let you capture feedback, run research programmes, and gather information from your contacts. They can be used as a standalone tool or integrated with UbiQuity emails, forms, and events.
- [Creating a Survey](https://docs.ubiquity.co.nz/documentation/data-capture/surveys/creating-a-survey.md): Creating a survey in UbiQuity takes just a few steps. You can start from scratch or copy an existing survey to save time.
- [Details and Settings](https://docs.ubiquity.co.nz/documentation/data-capture/surveys/details-and-settings.md): Survey details and settings control how your survey behaves, including when it closes, how many times someone can respond, and how it looks to respondents.
- [Questions and Pages](https://docs.ubiquity.co.nz/documentation/data-capture/surveys/questions-and-pages.md): This is where you build the content of your survey, adding pages, questions, and logic to create the experience you want for respondents.
- [Survey Logic](https://docs.ubiquity.co.nz/documentation/data-capture/surveys/survey-logic.md): Survey logic lets you personalise the survey experience for each respondent, showing or hiding questions, skipping pages, and branching to different paths based on how someone answers.
- [Triggered Emails](https://docs.ubiquity.co.nz/documentation/data-capture/surveys/triggered-emails.md): Triggered emails are sent automatically when a respondent completes your survey. You can send them to the respondent, to someone on your team, or to any email address based on conditions you set.
- [Deploying Your Survey](https://docs.ubiquity.co.nz/documentation/data-capture/surveys/deploying-your-survey.md): Once your survey is active, there are several ways to get it in front of respondents. The method you choose affects what data you can collect and how much you can personalise the experience.
- [Responses and Reporting](https://docs.ubiquity.co.nz/documentation/data-capture/surveys/responses-and-reporting.md): Once your survey is live, you can view, filter, and download responses in real time. You can also build reports to share results with others.
- [Events](https://docs.ubiquity.co.nz/documentation/data-capture/events.md): Track and capture customer interactions and behavioural data within the platform.
- [Creating an Event](https://docs.ubiquity.co.nz/documentation/data-capture/events/creating-an-event.md): Creating an event in UbiQuity takes just a few steps. You can start from scratch or copy an existing event.
- [Details and Settings](https://docs.ubiquity.co.nz/documentation/data-capture/events/details-and-settings.md): Event settings control the key details of your event including dates, capacity, registration behaviour, access controls, and pricing.
- [Fields and Validation](https://docs.ubiquity.co.nz/documentation/data-capture/events/fields-and-validation.md): This is where you build your event registration form, add fields, set validation rules, and configure how the form behaves.
- [Confirmation Message](https://docs.ubiquity.co.nz/documentation/data-capture/events/confirmation-message.md): Different confirmation pages appear to registrants depending on the outcome of their registration attempt. You can customise the content of each page.
- [Triggered Emails](https://docs.ubiquity.co.nz/documentation/data-capture/events/triggered-emails.md): Triggered emails are sent automatically when someone registers for your event, or at scheduled times relative to the event date. You can send them to the registrant, to your team, or both.
- [Deploying Your Event](https://docs.ubiquity.co.nz/documentation/data-capture/events/deploying-your-event.md): Every event has a unique URL. How you share that URL determines what data you can collect and how personalised the experience can be.
- [Registrations and Reporting](https://docs.ubiquity.co.nz/documentation/data-capture/events/registrations-and-reporting.md): Once your event is live, you can view and manage registrations in real time, filter and download the data, and share a report with others.
- [Layouts](https://docs.ubiquity.co.nz/documentation/data-capture/layouts.md): Layouts control the look and feel of your forms, surveys, and events. Set up your branding once and apply it across everything you publish.
- [Choosing an integration method](https://docs.ubiquity.co.nz/documentation/data-and-integrations/choosing-an-integration-method.md): Understand the different ways to bring data into UbiQuity, and choose the right approach based on your use case.
- [Imports](https://docs.ubiquity.co.nz/documentation/data-and-integrations/imports.md): Upload contacts and data into UbiQuity from a file — the simplest way to get data into the platform without a technical integration.
- [Importing contacts](https://docs.ubiquity.co.nz/documentation/data-and-integrations/imports/importing-contacts.md): A step-by-step guide to uploading and updating contacts in your UbiQuity database using a CSV or text file.
- [Importing transactions](https://docs.ubiquity.co.nz/documentation/data-and-integrations/imports/importing-transactions.md): A step-by-step guide to uploading and updating transactional data linked to your contacts in UbiQuity.
- [Connectors](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors.md): Automate data flows between your systems and UbiQuity using file-based integrations with SFTP, Microsoft Azure Blob Storage, and Amazon S3.
- [Before You Begin](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/before-you-begin.md): What you need to know and have in place before setting up your first Connector.
- [Creating a Connector](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/creating-a-connector.md)
- [Connection Setup](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/connection-setup.md): How to configure UbiQuity's connection to your SFTP server, Azure Blob container, or Amazon S3 bucket.
- [S3 Connection](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/connection-setup/s3-connection.md): Configure AWS IAM roles and permissions to connect your Amazon S3 bucket to UbiQuity Connectors.
- [Azure Blob Storage Connection](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/connection-setup/azure-blob-storage-connection.md): Configure your Azure Blob Storage account and authentication so UbiQuity can securely connect to your container.
- [SFTP Connection](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/connection-setup/sftp-connection.md): Configure your SFTP server and SSH key authentication so UbiQuity can securely connect to your files.
- [Preparing Your Files](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/preparing-your-files.md): What your files need to look like before you place them in your configured storage location.
- [Field Mapping](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/field-mapping.md)
- [Monitoring Connectors](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/monitoring-connectors.md): How to track Connector activity, review run history, and set up notifications.
- [Troubleshooting](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/troubleshooting.md): How to identify and resolve common Connector errors.
- [Security and Data Handling](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/security-and-data-handling.md): How Connectors protect your data in transit, at rest, and throughout the integration process.
- [FAQs](https://docs.ubiquity.co.nz/documentation/data-and-integrations/connectors/faqs.md): Common questions about how Connectors work, including scheduling, billing, and file handling.
- [API](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api.md): Use the API to integrate UbiQuity with other platforms and build custom workflows.
- [Common API calls](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/common-api-calls.md): A practical reference to the API calls used most often when integrating with UbiQuity.
- [Database](https://docs.ubiquity.co.nz/documentation/audience-management/database.md): Your contacts, fields, and interaction history — all managed in one place.
- [Opt Outs](https://docs.ubiquity.co.nz/documentation/audience-management/opt-outs.md): Manage unsubscribe preferences and ensure compliance with communication rules.
- [GNA (Gone No Address)](https://docs.ubiquity.co.nz/documentation/audience-management/gna-gone-no-address.md): Understand and manage GNAs (Gone No Address) for your audience.
- [Training](https://docs.ubiquity.co.nz/documentation/keep-learning/training.md): Learn how to get more out of UbiQuity with guided training delivered by our team.
- [Register for Training](https://docs.ubiquity.co.nz/documentation/keep-learning/training/register-for-training.md): Access to UbiQuity's generic online training.
- [Blog](https://docs.ubiquity.co.nz/documentation/keep-learning/blog.md): Explore product updates, ideas, and best practices on the UbiQuity blog.
- [ESL (UbiQuity's Scripting Language)](https://docs.ubiquity.co.nz/documentation/keep-learning/esl-ubiquitys-scripting-language.md): Guide to our scripting language to enable you to customise UbiQuity
- [Data Types](https://docs.ubiquity.co.nz/documentation/keep-learning/esl-ubiquitys-scripting-language/data-types.md): Learn more about the different data types you can have in UbiQuity
- [Merge Field Formatters](https://docs.ubiquity.co.nz/documentation/keep-learning/esl-ubiquitys-scripting-language/merge-field-formatters.md)
- [Directives](https://docs.ubiquity.co.nz/documentation/keep-learning/esl-ubiquitys-scripting-language/directives.md)
- [Variables](https://docs.ubiquity.co.nz/documentation/keep-learning/esl-ubiquitys-scripting-language/variables.md)
- [Functions](https://docs.ubiquity.co.nz/documentation/keep-learning/esl-ubiquitys-scripting-language/functions.md)

## Release Notes

- [UbiQuity Releases](https://docs.ubiquity.co.nz/releases/readme.md): Latest updates to UbiQuity, including features, improvements, and fixes.
- [1.180.0 - 15 July 2026](https://docs.ubiquity.co.nz/releases/2026/1.180.0-15-july-2026.md)
- [1.179.0 - 18 June 2026](https://docs.ubiquity.co.nz/releases/2026/1.179.0-18-june-2026.md)
- [1.178.0 - 20 May 2026](https://docs.ubiquity.co.nz/releases/2026/1.178.0-20-may-2026.md)
- [1.177.0 - 15 April 2026](https://docs.ubiquity.co.nz/releases/2026/1.177.0-15-april-2026.md)
- [1.176.0 - 25 March 2026](https://docs.ubiquity.co.nz/releases/2026/1.176.0-25-march-2026.md)
- [1.175.0 - 26 February 2026](https://docs.ubiquity.co.nz/releases/2026/1.175.0-26-february-2026.md)
- [1.174.1 - 14 January 2026](https://docs.ubiquity.co.nz/releases/2026/1.174.1-14-january-2026.md)
- [1.174.0 - 3 December 2025](https://docs.ubiquity.co.nz/releases/2025/1.174.0-3-december-2025.md)
- [1.173.0 - 12 November 2025](https://docs.ubiquity.co.nz/releases/2025/1.173.0-12-november-2025.md)
- [1.172.0 - 22 October 2025](https://docs.ubiquity.co.nz/releases/2025/1.172.0-22-october-2025.md)
- [1.171.0 - 18 September 2025](https://docs.ubiquity.co.nz/releases/2025/1.171.0-18-september-2025.md)
- [1.170.0 - 3 September 2025](https://docs.ubiquity.co.nz/releases/2025/1.170.0-3-september-2025.md)
- [1.169.0 - 20 August 2025](https://docs.ubiquity.co.nz/releases/2025/1.169.0-20-august-2025.md)
- [1.168.0 - 30 July 2025](https://docs.ubiquity.co.nz/releases/2025/1.168.0-30-july-2025.md)
- [1.167.0 - 10 July 2025](https://docs.ubiquity.co.nz/releases/2025/1.167.0-10-july-2025.md)
- [1.166.0 - 3 June 2025](https://docs.ubiquity.co.nz/releases/2025/1.166.0-3-june-2025.md)
- [1.165.0 - 19 March 2025](https://docs.ubiquity.co.nz/releases/2025/1.165.0-19-march-2025.md)
- [1.164.0 - 11 February 2025](https://docs.ubiquity.co.nz/releases/2025/1.164.0-11-february-2025.md)
- [Historical Releases](https://docs.ubiquity.co.nz/releases/historical-releases.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.ubiquity.co.nz/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.