If you're using legacy custom objects, you will continue to have access to your objects, records, and relationships. All resources to aid in your continued use of legacy custom objects have been labeled as "legacy." Custom object documentation without the "legacy" label applies only to the new custom object experience.
The Zendesk Sunshine platform lets you connect and understand all your customer data wherever it lives. The Sunshine data layer isn't associated with one Zendesk product, but you can model relationships to certain native objects like tickets and users.
The Sunshine platform currently consists of three resources: events, profiles, and legacy custom objects. Each can be accessed with APIs.
You can also interact with these resources in Admin Center. There you can see the available Sunshine data types and configure how the data is displayed natively to your agents in the customer context interface. By exposing Sunshine data in the customer context interface, your agents can work more efficiently and provide a better customer experience.
As an administrator, it's important to understand how the data from these resources is related, so this article introduces concepts and highlights key relationships.
Creating a single view of the customer
Sunshine profiles and events are powerful ways to unify data about your customer and their actions across applications and systems into a single view. Used together, Sunshine profiles and events can provide a more complete picture of each customer's journey with your organization.
Sunshine profiles act like name tags for a person in different applications, and they all tie back to individual users in Zendesk. This way, information about who the customer is and what they're doing in other applications is associated with a Zendesk user.
From Admin Center, you can see all of the Sunshine profiles for your account. You can also configure which of those custom profiles are visible in the customer context interface.
Sunshine events increase visibility into the actions of your customers in many sources. Any event that can be tracked, such as purchase transactions, website visits, or customer service interactions, can be a Sunshine event. There are two categories of Sunshine events: Zendesk events and custom events.
With native Zendesk events, data flows from Zendesk products into Sunshine events. Zendesk event data includes user profiles and certain interaction events from Support, Guide, and Talk, such as the titles of Help Center articles a customer viewed recently. They're a great way to get started with Sunshine data without needing assistance from a developer on your team. After you enable Zendesk events, they will become visible in Admin Center under the Zendesk events tab as each event type occurs.
With custom events, you can build a timeline of your customers' interactions from any other source. You'll see all of the Sunshine custom events for your account in Admin Center under the Custom events as soon as you enable the API and a developer in your organization connects it to external applications.
Every event is associated with a Sunshine profile, which means each event is also associated with a Zendesk user. Because of this association, you can use Admin Center to configure relevant Zendesk and custom events to be displayed in the customer context interface.
Learn more about Sunshine profiles and events
Using legacy custom objects to understand your customers
In addition to the many types of native Zendesk data objects, such as tickets and users, you can use Sunshine custom objects to store and surface data objects from any source. Custom objects can be just about anything, including a product, a service contract, or a customer visit. You can create custom objects in Admin Center or with the Custom Objects API, then use your custom objects and relationships to tailor your Zendesk account to fit your business needs.
Legacy custom objects and records
In Admin Center, you can create a blueprint for new legacy object types in Zendesk and control access to each object by setting role-based permissions. Then developers on your team can use the Custom Objects API to create, read, update, and delete object records. Object records are instances of the legacy custom object.
Because the blueprint, or schema, you define for each legacy custom object directly relates to the data and how it is stored in the database, it's important to model your data carefully. Custom objects support several different relationship models between object types: one-to-one, one-to-many, and many-to-many. See Modeling your data.
The following video provides an overview of custom objects in Admin Center:
Legacy object relationships
- two legacy custom object types
- one legacy custom object type and certain Zendesk object types
- two Zendesk object types
It's important to understand that defining a relationship type doesn't create an association between two specific records. Rather, it describes the relationship.
In Admin Center, you can create relationship types and control access to each relationship by setting role-based permissions. After you define your relationship type, developers on your team can create relationship records (instances of the relationship) to associate two object records.
Putting it all together
Individually, Sunshine events, profiles, and legacy custom objects each offer better insight into your customers and their relationship to your organization. Events and profiles are always oriented around users. When custom events, profiles, and objects are used together, you can start to see a complete picture of the customer in a single view. This enables you to break down knowledge silos, solve real-world problems, and increase efficiency.
In addition to exposing some of the Sunshine data in the customer context interface to improve your agents' ability to help your customers, you can also use Zendesk Marketplace apps or create your own Zendesk app to extend Zendesk Support and use more of your Sunshine data.
Enabling access to Sunshine
You'll need access to a Zendesk Suite plan. You must also activate the Sunshine platform APIs for the account before you'll be able to see data from the resources in Admin Center and customer context interface.
- In Admin Center, click People in the sidebar, then select Configuration > Event setup.
- To include Zendesk event data, click Sunshine features, then select Zendesk events.
- Save your changes.
To enable Sunshine custom events
- In Admin Center, click People in the sidebar, then select Configuration > Events.
- To enable data coming from Events API, click Get started.
- Save your changes.
To enable Sunshine profiles
- In Admin Center, click People in the sidebar, then select Configuration > Profiles.
- Enable data coming from the Profiles API, click Get started.
- Save your changes.
To enable legacy custom objects
- In Admin Center, click Objects and rules in the sidebar, then select Custom objects > Legacy objects.
- Enable data coming from the Custom Objects API, click Get started.
- Save your changes.