Front Platform

Welcome to the Front Platform. You'll find comprehensive guides and documentation to help you start working with Front as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Migration guide

🚧

What about the legacy plugin SDK?

With the release of the plugin SDK v1, the legacy version is now deprecated. While still supported, new features and improvements will be exclusive to the current version.

You can access the legacy documentation here.

Why a new version?

Since the legacy version of the plugin SDK was first designed and built, both Javascript and Front saw a lot of changes.

In addition to performance improvements, this new version brings support of promises and TypeScript, a data model closer to the one exposed by the Core API, etc...

API correspondence table

Legacy SDK

Current SDK

Notes

Front.on('conversation', ...)
Front.on('no_conversation', ...)

Front.contextUpdates.subscribe(...);

cf: Front.contextUpdates

Front.assign
Front.unassign

Front.assign

cf: assign

Front.toggleArchive
Front.toggleTrashed

Front.setStatus

cf: setStatus

Front.moveToInbox

Front.move

cf: move

Front.attachTag

Front.tag

cf: tag

Front.detachTag

Front.untag

cf: untag

Front.addTopic

Front.addTopic

cf: addTopic

Front.compose
Front.reply
Front.forward

Front.createDraft

cf: createDraft

Front.updateDraft
Front.insertHtml

Front.updateDraft

cf: updateDraft

Front.openUrl

Front.openUrl

cf: openUrl

Front.openPopupUrl

Front.openUrlInPopup

cf: openUrlInPopup

Front.search

Front.search

cf: search

Front.fetchTeam

Front.listTeammates

cf: listTeammates

Front.fetchInboxes

Front.listInboxes

cf: listInboxes

Front.fetchChannels

Front.listChannels

cf: listChannels

Front.user

The current teammate is now accessible on context.teammate.

Front.listAllowedTeammates

All teammates can be listed using listTeammates

Front.listAllowedTags

All tags can be listed using listTags

Front.fetchDraft

The draft ID is now available on the conversation of a context of type singleConversation.

Front.copyToClipboard
Front.prompt
Front.promptDate
Front.fuzzylist
Front.alert
Front.report
Front.confirm
Front.setPanelWidth

Not implemented.

Updated 5 months ago


Migration guide


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.