Integration Designer

Welcome to the Piano Integration Designer

Welcome to the Piano Integration Designer! This tool allows you to view, manage, and configure your customer data easily. With the Integration Designer, you can modify display names, export data to third-party platforms like Amazon S3, and more.

This guide will walk you through the key features of the Integration Designer, including how to ingest and export data, how to manage attributes, and how to work with data sources integrated with the tool.

Data Ingestion: How to Bring Data Into Piano Audience

Piano Audience offers several ways to ingest your customer data, whether through APIs or from other Piano products like Piano Management + Billing, Identity Management, and 1p data uploaded to Piano DMP. Below are the primary methods of ingesting data:

APIs

Our public APIs allow you to ingest data directly into our Customer Data Platform (CDP). Using the APIs, you can push customer events, attributes, and more into the platform. Data ingested via the API appears in near real-time in the Integration Designer interface.

For full documentation on how to use our APIs, refer to the Piano API Documentation here.

Piano Management + Billing

If you have licensed Piano Management + Billing, subscription related data is automatically available within Integration Designer. This integration enables you to leverage subscription-based insights seamlessly, the following attributes will be shared with Piano Audience:

• <prefix>-card-paid-after-exp

• <prefix>-churned

• <prefix>-gift-recipient

• <prefix>-next-billing-date

• <prefix>-registered

• <prefix>-sub-autorenew-off

• <prefix>-sub-card-expiration

• <prefix>-sub-in-grace-period

• <prefix>-sub-ltc

• <prefix>-sub-payment-term

• <prefix>-sub-start-date

• <prefix>-subscriber

• <prefix>-trial-free

• <prefix>-trial-paid

Additionally information around the access of a specific resource, such as:

• Resource ID

• Creation date

• Expiration date

are shared with Piano Audience for respective subscribers.

Identity Management

For clients using Identity Management, email addresses or social login vendor, user ids, account lifetime and all custom fields you’ve configured will also be accessible within Integration Designer. This allows you to manage user identity data, including login and custom profile information.

Piano DMP

If you’ve previously used Piano DMP, any first-party data that was ingested via APIs or managed imports will be available within Integration Designer. This ensures continuity in data management as we strengthen our CDP capabilities.

Understanding the Integration Designer Interface

The Integration Designer provides an intuitive interface to manage your data attributes.

Here are the key columns you’ll encounter: 

1. Display Name
   

   • The human-readable label for an attribute. 

   • Editable: You can modify this to make it more descriptive or user-friendly.
     

2. Name 

   • The system name or key that refers to the attribute in our platform. 

   • Non-editable.
     

3. Type 

   • Defines the type of data (e.g., string, number, boolean). 

   • Non-editable.
     

4. Source 

   • Indicates where the data originates (e.g., Piano Management + Billing, Identity Management, or API ingestion). 

   • Non-editable.
     

5. Destination 

   • Shows where the data is set to be exported, such as external platforms like Amazon S3. 

   • Non-editable. 

Managing and Modifying Attributes

Within the overview of your user profile attributes, click any item within the table to see respective details.

Editing Display Names

1. Navigate to the Integration Designer section of the interface.

2. In the Display Name column, click the name of the attribute you wish to modify.

3. Enter the new display name that better reflects the attribute.

4. Save your changes.

These updates will reflect immediately across the platform wherever the attribute is used.

Adding Descriptions to Attributes

1. Navigate to Integration Designer section of the interface.

2. Click on the attribute you wish to add a description for.

3. In the description field, enter any text (up to 400 characters) that provides additional details about the attribute.

4. Save your changes.

The descriptions are stored with the attribute and can help other users understand its purpose or usage.

Important Considerations for attribute management

When configuring user profile attributes in Integration Designer, keep the following in mind to ensure proper functionality across Piano products.

Reserved Fields for Data Ingestion in Piano Audience

For clients ingesting data directly into Piano Audience, certain fields are reserved by Piano for internal data processing and ingestion. These fields should not be overridden when sending custom data to avoid conflicts, data corruption, or unexpected behavior in user profiles and segmentation.

The reserved fields (prefixed with your customer prefix, e.g., abc-) include:

• <prefix>-card-paid-after-exp

• <prefix>-churned

• <prefix>-gift-recipient

• <prefix>-next-billing-date

• <prefix>-registered

• <prefix>-sub-autorenew-off

• <prefix>-sub-card-expiration

• <prefix>-sub-in-grace-period

• <prefix>-sub-ltc

• <prefix>-sub-payment-term

• <prefix>-sub-start-date

• <prefix>-subscriber

• <prefix>-trial-free

• <prefix>-trial-paid

Recommendation: When defining custom attributes, choose unique names that do not match these reserved ones. If you attempt to send data using these fields, it may be ignored, overwritten, or cause ingestion errors. Always review your data schema against this list before uploading.

Attribute Enablement for Segmentation and Piano Subscriptions (Composer)

User profile attributes ingested into Piano Audience are not automatically enabled for Segmentation or other connectors, except in specific cases outlined below. You must explicitly enable attributes to make them available for use in Segmentation or to export them via connectors.

Clients Using Both Audience and Piano Subscriptions (Composer)

The Composer connector in the Connectivity Hub controls which attributes are exported to Composer for use in User Profile Targeting. Because Composer and the Segment Builder share the same underlying data layer, any attribute enabled for Composer is automatically also available for Segmentation. The two cannot be configured independently — enabling an attribute for Composer inherently makes it available in the Segment Builder as well. For detailed guidance, refer to the Composer Integration Documentation.

Clients Using Only Piano Audience

Uploaded Data (Automatic Enablement)

All user profile attributes uploaded directly into Piano Audience are enabled automatically for Segmentation when the attribute contains your customer prefix. To ensure proper attribute recognition and enablement:

• Attribute Naming Convention: Import attributes using your assigned prefix format: <prefix>-attributeName. Example: If your prefix is abc and you want to import departureDate, name it as abc-departureDate.

• User Identifier Linking: Link the imported data to the user identifier already known by Piano Audience using the key format: cx-ext-<prefix>. Example: For prefix abc, use the key cx-ext-abc. This ensures the attribute data is properly associated with existing user profiles in Piano Audience.

Newly Created Attributes (Manual Enablement Required)

When you create new attributes — for example, Computed Traits — these are not automatically enabled for Segmentation. To make newly created attributes available in the Segment Builder, you must manually enable them via the Piano Audience Segmentation connector in the Connectivity Hub.

To enable new attributes for Segmentation:

1. Navigate to Connectivity > Configurations in Piano Audience.

2. Under Piano products, locate the Piano audience – Segmentation connector tile.

3. Open the connector and select which attributes you want to enable for use in the Segment Builder.

4. Save your configuration.

This connector gives you full control over which attributes are available for segmentation, allowing you to exclude attributes that are not relevant (e.g., PII fields or attributes not needed for audience building) while enabling those you do need.

Attribute Limit for Segmentation

A maximum of 100 attributes can be enabled for Segmentation at any given time. If you need to enable more than 100 attributes, please contact Piano support at support@piano.io for assistance.

Exporting Data from Piano Audience

The Integration Designer allows you to export data to third-party platforms and internal tools, giving you flexibility in how and where you manage your customer data.

Configuring Data Exports

Exports are managed through the Destination column in Integration Designer, which specifies where your data will be sent. To configure or update an export:

1. Click the field (row) in the Destination column for the data you want to export.

2. This will bring up an overlay, where you can either:

   • Select an existing connector to be redirected to the Connectivity Hub for configuration, or

   • Create a new connection if no connectors are set up yet.

Supported Export Destinations

At present, you can export data to the following third-party platforms:

• Amazon S3

• sFTP

• Google Cloud Storage (GCS)

These options are further detailed in our File Export documentation.

Internal Connectors

In addition to third-party platforms, Piano also supports exporting data to the following internal tools:

• Piano Composer  (Relevant to fuel User Profile Targeting)

• Piano Analytics

These connectors allow seamless integration within the Piano ecosystem. Like third-party exports, these internal connectors need to be properly configured in the Connectivity Hub before data can be exported.

Last updated: June 30, 2026