Newer Version Available

This content describes an older version of this product. View Latest

When to Use Connect REST API

Is Connect REST API the right API for you?

Use Connect REST API to:

  • Build a mobile app.
  • Integrate a third-party web application with Salesforce so it can notify groups of users about events.
  • Display a feed on an external system, such as an intranet site, after users are authenticated.
  • Make feeds actionable and integrated with third-party sites. For example, an app that posts a Chatter item to Twitter whenever the post includes #tweet hashtag.
  • Create simple games that interact with the feed for notifications.
  • Creating a custom, branded skin for Chatter for your organization.

How Is Connect REST API Different from Other Salesforce APIs?

These are some of the differences between Connect REST API and REST API.

  • Data is structured for rendering on websites and mobile devices.
  • Returned information is localized to the user's time zone and language.
  • Changed values that are tracked in a feed are returned as value-pair representations.
  • Rate limiting for Connect REST API is per user, per application, per hour. The rate limiting for SOAP API and REST API is by organization.

If needed, extract an ID from the REST API and use it in requests to Connect REST API.

Connect in Apex

Many Connect REST API resource actions are exposed as static methods on Apex classes in the ConnectApi namespace. This namespace is also referred to as Connect in Apex. Use Connect in Apex to develop applications on the Lightning Platform without using HTTP callouts from Apex.

The documentation for Connect in Apex is available in the Apex Developer Guide and the Apex Reference Guide.