Added user:removewebhook event. This event fires when a user deleted.
December 9th, 2024
Our Android SDK is being updated to support the following changes:
Files will now download directly to the device’s Downloads folder when clicked.
A new permission, WRITE_EXTERNAL_STORAGE, has been added for API level 28 and below to enable downloads. Please note that if the customer sets a maxSdkVersion different than 28 in their product, it will result in the following:
Devices with API levels between the customer’s max version (if it’s lower than the SDK’s max version) and the SDK’s max version will not be able to download files.
December 5th, 2024
iOS SDK 12.5.0. This minor version contains improvements.
Updated file attachments to load from a web view instead of the browser, allowing for the inclusion of authorization headers in requests for enhanced security.
Apple Message for Business. Rich links are automatically generated for any text message.
Update Apple Business messages documentation to include new optional parameters withCapabilities example
Update Apple business messages documentation to include example and description of the authentication message capability
October 28th, 2024
iOS SDK 12.4.0. This minor version contains improvements and some bug fixes.
Added method resetLastKnownAuthenticatedUser which allows to reset the last known authenticated user from persistence. Please note that this function must be called before the initialization.
The existing method forgetLastKnownUserForAppId has been deprecated. This change is made in favor of the new resetLastKnownAuthenticatedUser method. Please note that the appId parameter is no longer utilized, streamlining the process of the two methods.
Updated the implementation of the WebSocket connection to enhance stability.
October 17th, 2024
Added support for App Clips in Apple Messages for Business passthrough API.
September 24th, 2024
Our Android SDK is being updated to support the following changes:
Support for Android 15
Add additional error logs for the logging failure flow
Add extra checks in the codebase to help preventing crashes when fragment transactions are performed.
September 12th, 2024
The Stripe Connect Integration with Sunshine Conversations is deprecated on September 12, 2024.
After this date, the Stripe Connect Integration will no longer be supported or available.
The Help Scout Integration with Sunshine Conversations will be deprecated on January 6th, 2025.
After this date, the Help Scout Integration will no longer be available or supported.
All features supported by the Help Scout Integration are available in Zendesk. Additionally, a number of alternative integrations are available in our Marketplace.
July 15th, 2024
Updated per-channel default responder description with additional notes.
Existing conversations will not reflect latest setting without releaseControl.
To unset per-channel default responder, you can update defaultResponderId with null.
July 3rd, 2024
X Corp (Twitter) has been updated to the V2 API as the V1 API is being deprecated
Sending typing:start / typing:stop is no longer supported
Sending conversation:read is no longer supported
Reply actions + postback actions are now only partially supported (previously full)
See the Twitter DM page to see the updated list of capabilities
June 14th, 2024
Added support for per-channel default responder.
May 27th, 2024
iOS SDK 12.3.0. Messages generated by AI are displayed with a disclaimer appended to the end of the respective message.
Our privacy manifest is updated. All optionally collected data types are removed from the privacy manifest, keeping only the data that is collected as default for all Zendesk customers. If you collect any optional data that is not covered in the new manifest file, you will need to add them in your app’s privacy manifest file in order to be compliant with Apple’s privacy requirements. In addition, the manifest now includes collected data purpose values.
Fixes warnings.
May 8th, 2024
Android SDK 9.4.0. This minor version contains improvements and some bug fixes. Upgraded the Gradle version to 8.2.0 to resolve an issue where the SDK would crash with older Gradle versions. Added Generated by AI text after any message sent by Sunco SDK, which is generated by AI.
April 29th, 2024
iOS SDK 12.2.2. This patch version contains: Adds NSPrivacyCollectedDataTypes to the privacy manifest according to Apple’s guidelines on describing data use. For more information on our data collection, see our App Privacy Details article. Fixed an issue where an incorrect URL would cause a 404 response when calling Smooch.conversationById.
April 24th, 2024
Updated Android push notifications schema
iOS SDK 12.2.1. This patch version contains: A privacy manifest has now been added. Fixed an issue where the conversation header was not visible in right-to-left languages. Important Note: A problem was identified with the privacy manifest in this release preventing privacy reports from being generated, it is fixed in the later 12.2.2 release.
April 11th, 2024
Added metadata in the notification payload when messageSchema is specified
March 20th, 2024
matchResult will now be sent consistently across all notification:* webhooks.
matchResult will now always include client, appUser and conversation.
Added explanation that generative AI disclaimer added to the text field counts towards the character limit.
March 4th, 2024
Added support for subroles in messages. This new array of strings indicates the author’s subtypes when the role is set to appMaker.
January 12th, 2024
Android SDK 9.3.0. This minor version contains improvements and some bug fixes. Fixed an issue where the login API was being unresponsive due to callbacks not being triggered. Upgraded play-services-location dependency to resolve an issue where the SDK would crash when sharing location. Fixed an issue that would cause the SDK to crash due to a ConcurrentModificationException. Added method resetLastKnownAuthenticatedUser to reset the last known authenticated user from persistence. Added a flag ignoreLastKnownUser to Settings API to be used during initialization.
October 18th, 2023
iOS SDK 12.2.0. This minor version contains bug fixes and enhancements: The minimum iOS deployment target of the SDK is now iOS 12. Fixed an issue where a handler was not being called to return an error when no externalId was present during login. Added a method forgetLastKnownUserForAppId to forget the last known user from persistence. Added an initializer for SKTSettings with a parameter to ignore the last known user. Additional hardening to prevent crashes occurring in the SDK.
August 21st, 2023
Android SDK 9.2.0. This minor version contains support for Android 14 and some bug fixes. Fixed an issue where the conversation list is out of order. Added fixes for null pointer exceptions. Fixed an issue that would cause the SDK to crash if the Fragment Manager is destroyed.
Jun 23nd, 2023
iOS SDK 12.1.1. This minor version fixes the issue when logout call returns with 404 HTTP error.
March 28th, 2023
Conversations now have a maximum size of 30,000 messages. Once you reach this maximum, a 423 Locked HTTP status code is returned when trying to post a new message. To allow more messages to be sent to the affected conversation, you must delete all messages to make room.
February 22nd, 2023
Android SDK 9.1.2. This minor version contains bug fixes and enhancements including a fix where the connection banner would cause a crash due to a null pointer exception and the createConversation method now returns the ID of the newly created conversation.
February 2nd, 2023
iOS SDK 12.1.0. This minor version fixes a hang risk warning in Xcode 14, provides additional hardening to prevent crashes occurring in the SDK and adds a serviceBaseUrl property that can be set on the settings object.
November 16th, 2022
Fixed an issue where rendering the conversation screen on larger screens like tablets would cause the SDK to crash.
Fixed an issue where region was not taken into account when requesting config.
September 1st, 2022
Added support Android 13.
Updated targetSdkVersion and compileSdkVersion to 33.
Added support for POST_NOTIFICATIONS permission.
Updated minSdkVersion to 21.
The Switchboard passControl action is now idempotent if either the target switchboardIntegration is specified explicitly by its id or name, or the next keyword is used for the switchboardIntegration field, and the invoking integration can be identified by its OAuth token or Custom Integration API Key credentials. Duplicate passControl actions using the next keyword and their metadata are disregarded.
Messages authored by the platform such as in structured messages are localized into the language of the recipient, based on appUser locale, with the app’s associated Zendesk account locale as a fallback.
Localization is opt-out by toggling the appLocalizationEnabled flag to false from the API (see Settings > appLocalizationEnabled).
If an appUser does not have a locale determined from a source channel, their locale is set based on locale detection of their messages using CLD2.
iOS SDK 10.1.3 This patch version contains bugfixes for an issue that caused the keyboard to render over the text-input field, and an app crash related to showing the conversation.
March 23th, 2022
Added user:update event. This event currently fires when an anonymous user is converted to an authenticated user.
Buy, Location Request, and List actions are no longer supported on Facebook Messenger as they have been deprecated by Facebook.
December 15th, 2021
iOS SDK 10.1.2 This minor version contains bug fixes and enhancements, as well as a new Sample App and support for Swift Package Manager. This version also removes support for universal frameworks - for information on how to install the XCFramework, check out our documentation.
December 1st, 2021
Web Messenger [5.3.14] Replaced the blue with the action color for “New conversation” button, reconnection banner, composer and menu highlight
iOS SDK 10.1.0 This minor version contains bug fixes and enhancements including better Message Delivery tracking, adding the return of userExternalId when fetching conversation participants, and enchanced Dark Mode customization.
Android SDK 8.2.0 This minor version contains bug fixes and enhancements including better Message Delivery tracking, adding the return of userExternalId when fetching conversation participants.
January 28th, 2021
Updated the Web Messenger Faq with information to add Web Messenger to Zendesk Guide.
Added support for tracking user delivery events on the Sunshine Conversations Web Messenger with release 5.3.0. See Delivery Events for more information.
January 22nd, 2021
iOS SDK 10.0.0 This major version contains support for XCFramework, and a number of bug fixes and improvements. These include enhanced support for Xcode 12. You may now configure the colour of text in a carousel. We’ve also added the ability to send “avatarUrl” when creating a conversation.
January 15th, 2021
Added support for WhatsApp sticker.
Added support for receiving webp file type. See File Validation for more information.
January 6th, 2021
Removed channelId and channelSecret as required fields when creating a LINE integration.
December 16th, 2020
Updated the limit of the select field options from 20 to 100 for form messages.
December 15th, 2020
Added a new user profile field locale in the v2 API.
Updated the Facebook Messenger guide page with a section on the impact of the Messenger API updates for Europe.
December 10th, 2020
Added the ability to pass an integrationType of none when sending a message and targeting a specific channel. For more information, consult the guide for sending silent messages.
Business messages are no longer duplicated to Facebook Messenger when it is not the preferred channel for the user.
conversation:join for when a user joins a sdkGroup conversation.
conversation:leave for when a user leaves a sdkGroup conversation.
conversation:remove for when a conversation is deleted.
November 17th, 2020
Added a new optional field altText to the message schema when sending an image or a file. If the field is not provided the value will be updated with the filename.
November 15th, 2020
Added support for Instagram Direct.
November 11th, 2020
Released Ruby SDK and Python SDK, which have been revamped to support the v2 API.
Web Messenger 5.0.0. This major version enhances the support for Multi-Conversations, introduces a new conversation list view, and brings a fresh new design for the Web Messenger. We have also included updates to the conversation view to display the conversation’s icon, description, and name. Your integration can also be configured to allows users to create new conversations directly from the conversation list view.
September 29th, 2020
Added a new optional field avatarUrl to the app user schema. It will be the one used by default when no avatarUrl is directly provided in app user messages.
September 24th, 2020
Android SDK 8.0.0 This major version enhances the support for Multi-Conversations and introduces a new conversation list UI. We have also included updates to our conversation screen UI to show the conversation icon, conversation name and description. You can also configure your app to allow users to create multiple conversations from our conversation list screen. The release also includes support for Android X and we’ve fixed a bug relating to JWT expiry which invokes an auth delegate required to refresh the JWT and reattempt connection.
iOS SDK 9.0.0 This major version enhances the support for Multi-Conversations and introduces a new conversation list UI. We have also included updates to our conversation screen UI to show the conversation icon, conversation name and description. You can also configure your app to allow users to create multiple conversations from our conversation list screen. We’ve fixed a bug relating to JWT expiry which invokes an auth delegate required to refresh the JWT and reattempt connection.
August 27th, 2020
Added support for Apple Business Chat.
August 26th, 2020
Updated the timezone database for the Office Hours add-on. Daylight savings time offsets are now correctly applied to all timezones.
August 19th, 2020
When creating a webhook as an Integration Partner, a maximum of 3 webhooks per client is allowed.
August 11th, 2020
Added support for uploading and sending .heic files.
July 30th, 2020
Android SDK 7.0.3 released with bug fixes including a fix for an issue related to Proguard rules and a fix for an issue related to DexGuard.
iOS SDK 8.0.2 released with a bug fix for a bug related to getConversations returning nil for metadata.
June 25th, 2020
Delivery to user events are now displayed in the web app Logs tab for supported channels. For more information about delivery events, consult the guide.
June 15th, 2020
Android SDK 7.0.2 increased the file size limit for attachments to 25MB, bug fixes include a fix for a bug related to taking a photo with the camera or choosing an existing photo on Android 10 when sending attachments, and a bug that causes the SDK to crash with certain special characters in the app name.
iOS SDK 8.0.1 released with file size limit for attachments raised to 25MiB, and bug fixes including fix for a bug that would prevent one of the customizations in the navigation bar.
April 16th, 2020
iOS SDK 8.0.0 released, with additional support for multi-conversations and initial support for multi-party conversations.
April 13th, 2020
Added a new API to fetch the IDs required to initialize the new integrationId-powered versions of our SDKs. See the Get SDK IDs API for more information.
March 31st, 2020
Added support for sending Notifications with the Sunshine Conversations API. See the Outbound Messaging guide for more information.
Android SDK 7.0.0 released, with additional support for multi-conversations and initial support for multi-party conversations.
March 12th, 2020
Web Messenger 4.28.8 released, which increases the accepted size for uploaded files from 10MB to 25 MiB.
March 10th, 2020
Added the ability to delete custom user properties. Learn more
March 2nd, 2020
Opened up registration for the Multi-Party Conversations EAP. This early access release is a preview of the next generation of functionality in Sunshine Conversations, including multi-party conversations, multiple conversations per user, and multiple instances of messaging channel integrations. Learn all about it in the early access guide.
February 26th, 2020
Added documentation for supported user properties for office hours.
February 24th, 2020
Added native support for audio messages sent to WhatsApp. Learn more
February 20th, 2020
Added support for dual-purpose sandbox & production certificates for Apple Push Notification service. A production boolean may now be specified when uploading a certificate via the Create Integration API.
February 17th, 2020
Added toggling support for whether a non message event should trigger a conversation start and count as a monthly active user (MAU). See App Settings for more information.
February 5th, 2020
Added typing indicator support in WeChat.
January 21st, 2020
Added support for receiving bmp file type. See File Validation for more information.
January 13th, 2020
Fixed a bug where the authorId of a deleted message was not returned.
Added support for specifying a custom fromAddress when integrating or updating a Mailgun integration.
December 24th, 2019
Fixed a bug where credit card numbers were not masked in the webhook payload when maskCreditCardNumbers was set to true.
December 17th, 2019
Web Messenger 4.27.9 released, which allows appUsers to send animated GIFs.
December 12th, 2019
Added a new Shorthand Syntax when sending WhatsApp messages. This syntax supports the new template message type. The old syntax will continue to work but it is deprecated. See this section for more information about the deprecation.
November 18th, 2019
Web Messenger 4.27.0 released, which improves overall performance.
Added support for WhatsApp Message Template Reconstruction which enables the conversation history stored by Sunshine Conversations to reflect the content of a Message Template as seen by the user, so that all the software connected to the conversation (e.g. agent software or bot platform) have the full context. See the WhatsApp Message Templates documentation for more details.
Web Messenger 4.22.0 released with a new loadConversation API which loads a conversation into the current session.
August 28th, 2019
Added detection for users blocking a business on Twitter, Viber and WeChat.
Added a client:block webhook that triggers when a client’s status changes to "blocked". Supported on LINE, Mailgun, Twitter, Viber, and WeChat.
iOS SDK 6.16.0 released with support for customization of the text color for user messages. Learn more.
August 26th, 2019
Added the ability to configure a custom Prechat Capture form by specifying the prechatCapture.fields property in the init configuration. Look at our documentation on our website and on GitHub for more info.
Added support for basic authentication for the Sunshine Conversations API. This new mechanism is now the recommended method to authenticate server-to-server API requests. It allows an API key (previously known as secret key) to be used directly, removing the need to generate a JWT before using the API.
Updated the dashboard’s WhatsApp integration page allowing users to deploy API clients or to connect to an existing one. See WhatsApp guide for more information.
Web messenger 4.19.0 released with a new onInvalidAuth conversation delegate that notifies of a failed request due to invalid credentials. A common use for this is to allow the implementer to set a new auth token in order to retry the request.
May 27th, 2019
Added the ability to manually trigger a merge between two users. See the merge user API and user merging guide for more information.
Launched version 0.1 of the Sunshine Conversations Conversational Design Kit which helps Product Design teams create better conversational experiences on Sunshine Conversations. This version covers design patterns for chat frames, action buttons and form messages on Web Messenger.
May 9th, 2019
Added new fields status and externalId to the client schema. The active and blocked fields have been replaced by status and are now marked as deprecated. They will be removed in a future API version.
Web Messenger 4.17.15 released with two new API functions for managing user typing activity, Smooch.startTyping() and Smooch.stopTyping().
May 7th, 2019
Web Messenger 4.17.14 released to fix a bug where the chat widget styles are not initialized correctly.
May 1st, 2019
Added a new suite of API to programatically deploy and register new WhatsApp API Clients on the fly. See our guide and the deployment API reference for more details.
iOS SDK 6.13.0 released which accepts an authentication delegate as an init setting that gets notified when a request fails because of an invalid JWT, allowing you to renew credentials without having to call [Smooch login:jwt:completionHandler:].
April 26th, 2019
Android SDK 5.18.0 released which accepts an authentication delegate as an init setting that gets notified when a request fails because of an invalid JWT, allowing you to renew credentials without having to call Smooch.login(String, String).
April 12th, 2019
Added new settings includeClient and includeFullAppUser to webhooks. When turned on includeFullAppUser adds properties, surname, givenName & signedUpAt to appUser. includeClient adds the client associated with the webhook event. Note that includeFullAppUser is on by default, even for existing v1.1 webhooks. includeClient is opt-in. See an example webhook payload here.
April 11th, 2019
Web messenger 4.17.13 released which now accepts delegate as an init parameter.
March 25th, 2019
Changed file validation timeout to 15 seconds. Learn more
Added new fields _id and deviceId to the client schema. The id field is now marked as deprecated and will be removed in a future API version.
Sunshine Conversations now displays a banner to indicate when the connection is lost.
Two new events connected and disconnected can now be subscribed to. For example: Smooch.on('disconnected', () => {}).
Fixed a bug where multiple calls to start a conversation or create a user could cause the creation of duplicate appUsers or a 409 conflict error.
February 14th, 2019
When a displayName is not provided when creating a new integration, a default value matching the channel type is set (i.e. MessageBird SMS). Learn more
February 11th, 2019
WhatsApp Business Profile information can now be edited through the dashboard.
February 6th, 2019
Added a new field displayName to 3rd party channel integrations. Learn more
iOS SDK 6.12.0 released with support for multiline action buttons, and a few visual adjustments.
January 29th, 2019
Added support of Service Code, an optional parameter in LINE integrations.
January 24th, 2019
Added a new field integrationId to link:match, link:success, and link:failurewebhook events.
Added a new field destination.integrationId to delivery:success and delivery:failurewebhook events (v1 API).
A Google Maps API Key is now required to render location messages with a maps preview, otherwise they are rendered as text messages. This change is due to Google’s requirement to provide an API key to use the Static Maps API. To set your API key, use Settings#setMapsApiKey(String) before calling Smooch.init(Application, Settings, SmoochCallback)
Fixed a bug where messages from a user sent from another client were displayed as notifications
Updated error description when initializing the SDK failed due to invalid login credentials
New color resource Smooch_conversationBackground allows customization of the conversation background color
A new Conversation extensions configuration to automatically open them. Set the openOnReceive property on a Webview Actions and Web Messenger will open it when receiving the message. Learn more.
Webview Actions can now include the openOnReceive property to have them open automatically in the Web Messenger. See docs.
November 29th, 2018
Added a new appUser:deletewebhook for when an app user is deleted through the Delete App User API.
November 21st, 2018
Messages from WhatsApp now populate the appUser’s givenName and surname if possible, and WhatsApp clients now include raw client info.
iOS SDK 6.11.0 released which adds support for the metadata field in SKTMessageItem
October 4th, 2018
Added a new conversationRetentionSeconds app setting to automatically clear messages in idle conversations. Learn more
September 27th, 2018
Added a new supported template message syntax: %((template:))%. The %{{template:}}% syntax is still supported. Learn more
September 24th, 2018
Web messenger 4.14.0 released with support for modifying the properties of a message before it’s sent to Sunshine Conversations. A common use for this is adding message metadata.
Sunshine Conversations now limits the type of files you can upload/send on the platform. See the file validation guide for the list of allowed file types.
The logic used to assign a name to a message has been updated. Instead of generating an animal name for anonymous users, message names will be chosen based on this logic.
A new init parameter notificationChannelPromptEnabled is available to disable the notification prompt shown after a user’s first message (e.g. Smooch.init({ notificationChannelPromptEnabled: false })).
A new API Smooch.setPredefinedMessage(message) is available to prefill the user’s chat input.
A new API Smooch.showNotificationChannelPrompt() is available to display the channel linking notification at any time.
Web Messenger now supports multiline user messages!
In order to add a new line to a message, press Shift+Enter instead of Enter.
Additionally, messages which span longer than one line will also expand the message input up to five lines before enabling scrolling.
August 21st, 2018
Added a sample template to send a NPS survey. Learn more.
August 20th, 2018
Web messenger 4.12.14 fixes an issue where message:received events are sent when there are unread messages during the initialization
August 17th, 2018
Android SDK 5.14.0 adds support for apps targeting Android 9.0 (Pie) or higher.
Fixed a bug that auto scrolling from working properly
Fixed an issue where bubbles would sometimes render with a very narrow width
June 26th, 2018
Optimized server side web socket connection handling to improve energy consumption for mobile SDKs
June 19th, 2018
Web Messenger 4.12.5 released with fixes for syncing messages across multiple browser sessions, and loading the iframe in certain browser environments.
June 13th, 2018
Android SDK 5.13.0 released with support for starting text which allows you to pre-fill the text box when showing the conversation.
June 12th, 2018
iOS SDK 6.10.0 released with support for starting text which allows to pre-fill the text box when showing the conversation.
Added native support for list messages in WeChat. See the WeChat guide and the List Message documentation for details.
February 14th, 2018
Android SDK 5.9.0 released with support for initialization from an Activity
Updated LINE channel to gracefully handle users who block the business. A delivery:failure webhook will now be triggered when attempting to deliver messages to such LINE users.
Added support for business read receipt for Messenger channel.
Android SDK 5.6.0 released with support for business read receipt.
iOS SDK 6.5.0 released with support for business read receipt.
November 23rd, 2017
Failed webhook delivery attempts are now displayed in the web app Logs tab. Before, webhook failure logs would only show up after retry attempts were exhausted.
Web Messenger 4.3.4 released with support for user typing events.
Android SDK 5.5.0 released with support for user typing events.
iOS SDK 6.4.0 released with support for user typing events.
November 16th, 2017
Introduced a new set of APIs for transferring conversations to and from Sunshine Conversations SDKs and third party messaging apps. Read more about this in the channel transfer guide.
November 9th, 2017
Android SDK 5.4.1 adds support for message timestamps in the conversation.
November 1st, 2017
Android SDK 5.4.0 adds support for notification channels for apps targeting Android 8.0 (Oreo) or higher.
Added a new api endpoint to retrieve all the business systems an appUser’s conversation connects to.
September 18th, 2017
Android SDK 5.0.0, Web Messenger 4.0.0 and iOS SDK 6.0.0 have been updated with a new optimized initialization sequence. See release notes for more details.
September 1st, 2017
Introduced a 14-day trial period for API usage on free plans
August 15th, 2017
iOS SDK 5.8.2 was released with support for iOS 11 and XCode 9
July 29th, 2017
Added raw client info to clients reflecting profile information available from each channel
Updated Create App API with new maskCreditCardNumbers option
Updated Sunshine Conversations API libraries to fix issue caused by empty arrays being sent to the server and added reasonable defaults for limit and offset params
May 11th, 2017
Added a new page in the dashboard which lets you see and manage all of your Sunshine Conversations apps
Added the ability to quickly navigate between your Sunshine Conversations apps from anywhere in the dashboard using name or Id
Speed and performance have been improved for accounts with a large number of Sunshine Conversations apps
The Sunshine Conversations dashboard was given a facelift for an experience that is more intuitive, productive, and enjoyable