Welcome to the Community developer hub. You'll find comprehensive guides and documentation to help you start working with Community as quickly as possible, as well as support if you get stuck. Let's jump right in!
Getting Access
In order to use Community's APIs, your account will need to be provisioned by the Community team. If you've received a technical onboarding packet, you're good to go. If not, you'll want to talk with your Account Manager, or email us at [email protected] to get started.
The Community platform offers multiple categories of API, which are described below.
REST API
The REST API is a synchronous API for managing your Community data in real time. Every request returns a complete response right away, so you know immediately whether a call succeeded and you get the resulting record back. You don’t have to wait on a callback or poll for status. Today it supports managing Members and Subcommunities, including creating, updating, and retrieving them, with more capabilities on the way. Learn more in the REST API section to the left.
Data Export API
Community's Data Export API allows programmatic retrieval of account data in CSV or JSON formats. This data includes Member detail information, campaign performance, link click performance, and other data. Learn more in the "Data Export API" section to the left.
Webhooks
Webhooks are HTTP requests we send to an Endpoint you provide. They will be executed when certain events occur in our system, such as when a Member joins your account, or when a Member sends you a message.
Async REST API
Community's Async REST API offers a programmatic interface to send messages, create new Members, set custom data values, and more. Learn more in the "Async REST API" section to the left.
Note: The Async REST API is our legacy API. It’s still supported for existing integrations, but it won’t receive new features. All new development is going into the REST API.
