As Sunshine Profiles and Events prepares to move from Early Access to General Availability, we are making changes to our APIs to address customer feedback and improve the product.
Today we are announcing new v2 APIs for Sunshine Profiles and Events, as well as the deprecation and removal of access to the v1 APIs, scheduled for April 6th, 2020. Jump ahead to read what’s changing.
This change aligns Sunshine Profiles and Events with Zendesk Users to make it easier for you to have a single view of your customers within Zendesk. Jump ahead to read about the benefits of this change.
This update covers the following topics:
What’s changing
Review our detailed API Migration Guide for a more in-depth exploration or what's changing, including side-by-side API comparisons.
v1 API - Deprecating
The following v1 APIs are now deprecated and access will be removed on April 6th, 2020;
/api/sunshine/people/api/sunshine/profiles/api/sunshine/events/api/sunshine/track(previously announced)
v2 API - Launching
The following v2 APIs replace those above, and have already been enabled on all existing Sunshine accounts
/api/v2/users_profile/api/v2/users_profile/events/api/v2/users_profile/{profile_id}/events/api/v2/users/{user_id}/profiles/api/v2/users/{user_id}/events
Review our Profiles v2 API and Events v2 API specifications for a more detail on the v2 APIs.
Why we’re making this change
There are many benefits of this change, but the key benefit is that it is now easier for you to create a single view of your customer that includes their federated profile information, contact data and interactions.
The underlying changes in the v2 API that enables this are;
- Sunshine Profiles and Events are now automatically linked to Zendesk User
- Where a Zendesk User does not exist, it will be automatically created
- Events can be sent with only an external identifier, and it will now be automatically linked to the Zendesk User
How will it impact you
This is a breaking change to the v1 API.
If you’re using any of the Profiles and Events v1 APIs you will need to migrate to the v2 API before April 6th, 2020. After this date we will remove access to the v1 API and your requests will not be processed.
We have prepared a detailed API Migration Guide which has side-by-side comparisons of the v1 and v2 APIs and goes through all the updates that are required.
You can also review the new API specifications for the v2 Profile API and v2 Event API
Key date
April 6th 2020, access to the v1 API will be removed
FAQ’s
What feedback led to this change?
During the EAP we’ve been asked to make it easier to sync Sunshine People, Profiles and Events with Zendesk Users and their interactions. Bringing these two concepts together makes Sunshine Profiles and Events easier to use with Zendesk Users and requires no special data handling to make it occur.
When can you begin migrating to the v2 API?
Immediately. The v2 API is already in production and available on all accounts using Sunshine, there is no action required by you to enable the v2 API.
What happens if you don’t migrate?
On April 6th, 2020 your requests to Sunshine Profiles or Event will no longer be processed.
What happens if you’re using a partner app or integration with Sunshine?
You shouldn’t have to do anything. Partners have already been notified of the API changes, and it will be their responsibility to make these changes for Profiles and Events. It’s possible that you may be asked to update or install a new version of their app to continue using Profiles and Events.
What happens to existing data in Sunshine?
If you’re already using the v1 API, we are currently migrating historical data and maintaining an active sync of new data across to the v2 format until the v1 APIs are deprecated. Please note; The historical migration may take a number of weeks.
Are there any changes to API payloads, responses or query strings?
Yes. Refer to our API Migration Guide for a side-by-side comparison of what’s changing. Alternative, you can review the Profile v2 API or Events v2 API specifications.
Will this be the last breaking change to the Profile and Events API?
Profiles and Events is still in EAP, and we reserve the right to make changes when it is necessary. With that said, we are working towards our General Availability and there are no further breaking changes to the APIs planned.
What happens to Sunshine People?
The Sunshine People / Person concept has been deprecated. Sunshine Profiles and Events will instead be directly linked to a Zendesk User.
Further Questions
That's all for now, if you have questions that haven’t been addressed by this announcement, please feel free to reach out to us by either leaving a comment below, join our community, get in touch with your account manager or email us at support@zendesk.com
0 Comments
Please sign in to leave a comment.