Planning Center API Essential Guide

Aug 16, 2024 • 6 minute read

What type of API does Planning Center provide?

API Type

Planning Center has a single REST API that conforms to the JSON API 1.0 specification.

Key Features

There's a single API for all of Planning Center's products, including Check-Ins, Giving, Groups, People, Calendar and Services.
The API uses JSON as the data format.
It follows REST principles, using standard HTTP methods for operations.

API Access

Developers can access the API using a Developer Access Token.
The API allows exploration and management of a church's data.

Community and Support

Planning Center has a Slack community where developers can ask questions and get help with the API.
There's a #api channel specifically for API-related discussions.

Third-Party Integrations

Many third-party products have built integrations with Planning Center using their API.
Planning Center encourages developers to share their integrations for potential inclusion in their integrations directory.

Best Practices

Using resource-based URLs
Implementing stateless communication
Utilizing standard HTTP methods (GET, POST, PUT, DELETE) for operations
Proper error handling using HTTP status codes

Does the Planning Center API have webhooks?

Yes, the official Planning Center API does have webhooks. Here are the key points about Planning Center's webhook functionality:

Webhook Availability

Planning Center introduced webhooks in September 2017.
Webhooks allow applications to receive real-time updates from Planning Center without having to continuously poll the API.

Event Types

Planning Center offers webhooks for various event types, including:

People-related events:
- Person created (people.v2.events.person.created)
- Person updated
- Person removed
Giving-related events:
- The Giving API supports webhooks for donation-related updates

Setting Up Webhooks

To set up webhooks in Planning Center:

Log in to the Planning Center API dashboard at https://api.planningcenteronline.com
Go to the Webhooks tab
Set up a new subscription by providing an endpoint URL
Select the events you want to subscribe to

Key Features

The webhook system is built on the existing REST API
There's an interface for inspecting requests and responses
Manual redeliveries can be initiated for easier debugging
There are no rate limits
The system handles brief outages with automatic retries (up to 16 times with exponential backoff)

Best Practices

Consider setting up specific URLs for different types of updates (e.g., https://myapplication.com/planning-center-integration/person-update for person-related events)
Use the webhook data to keep your local databases or systems in sync with Planning Center

Additional Notes

Initially, webhooks were focused on Planning Center People, but the intention was to expand to other Planning Center applications over time
As of 2021, the Giving API also supports webhooks

In summary, Planning Center's API offers webhook functionality, allowing developers to receive real-time updates for various events, particularly related to people and giving data. This feature enables more efficient integrations and real-time data synchronization between Planning Center and external applications.

Rate Limits and other limitations

Based on the search results provided, here are the key points regarding the API rate limits for the Planning Center API:

API Rate Limits

Unfortunately, the search results do not contain specific information about Planning Center's API rate limits. The provided sources do not mention any numerical limits or restrictions on API usage for Planning Center.

Key Points to Consider

The Planning Center API is a single API that interfaces with multiple Planning Center products, including Check-Ins, Giving, Groups, People, Calendar, and Services.
Planning Center provides an API Explorer tool that allows developers to browse and test API endpoints.
The API Explorer is read-only, so developers can safely explore the API without risking any data modifications.
Planning Center has a customer community on Slack where developers can ask questions and get help with the API.

Best Practices

While specific rate limits are not mentioned, it's generally a good practice to implement rate limiting and error handling in your API integrations.
Use the API Explorer to familiarize yourself with the available endpoints and test your queries before implementing them in your application.
Join the Planning Center Slack community to stay updated on API changes and get support from other developers.
If you're developing a third-party integration, consider reaching out to Planning Center to have it included in their integrations directory.

It's important to note that the search results do not provide specific information about Planning Center's API rate limits. For accurate and up-to-date information on rate limits, it would be best to contact Planning Center's support directly or check their official API documentation.

Latest API Version

Based on the search results provided, there is no specific mention of the most recent version of the Planning Center API. However, I can provide some relevant information about the Planning Center API:

Key Points:

Planning Center offers a single API that interfaces with multiple products, including Check-Ins, Giving, Groups, People, Calendar, and Services [1].
The API conforms to the JSON API 1.0 specification [1].
Planning Center regularly updates their API and notifies third-party developers of potentially breaking changes via a mailing list [1].

API Documentation:

The Planning Center API documentation is available at developer.planning.center/docs.

API Updates:

While there is no explicit mention of the most recent version, it's worth noting that:

Planning Center is committed to continually improving their services [5].
They regularly release updates and new features across their various products [5].
The changelog shows frequent updates, with the most recent entries dating up to July 2024 [5].

Best Practices:

To stay updated on API changes, developers should subscribe to the Planning Center mailing list for API updates [1].
Developers can join the Planning Center Slack community, specifically the #api channel, to ask questions and get help with the API [1].
When working with the API, always refer to the most recent documentation available at developer.planning.center/docs.

In conclusion, while the exact version number of the most recent Planning Center API is not provided in the search results, the API is actively maintained and updated. Developers should refer to the official documentation and stay subscribed to Planning Center's update channels for the most current information.

How to get a Planning Center developer account and API Keys?

To get a developer account for Planning Center and create an API integration, you can follow these steps:

1. Access the Developer Portal

First, you need to access Planning Center's developer portal. You can do this by visiting their official developers page at https://www.planningcenter.com/developers.

2. Obtain a Developer Access Token

To start using the Planning Center API, you need a Developer Access Token. Here's how to get one:

Log in to an active Planning Center organization
Generate a Developer Access Token from within your account

3. Familiarize Yourself with the API

Planning Center offers a single API that interfaces with multiple products, including Check-Ins, Giving, Groups, People, Calendar, and Services. The API conforms to the JSON API 1.0 specification.

4. Explore the API Documentation

Visit the Planning Center API documentation at https://developer.planning.center/docs to learn more about the available endpoints and how to use them.

5. Start Building Your Integration

With your Developer Access Token and knowledge of the API, you can start building your integration. Planning Center's API is open and fully documented, allowing you to create custom solutions for your church's needs.

6. Join the Developer Community

For additional support and updates:

Subscribe to the developer mailing list to receive notifications about API updates and potential breaking changes
Join the Planning Center Slack community and participate in the #api channel to ask questions and get help from other developers

7. Consider Getting Your Integration Listed

If you've created an integration that could be useful for other churches, you can submit it for consideration to be included in Planning Center's integrations directory.

What can you do with the Planning Center API?

Based on the search results provided, here is a list of data models you can interact with using the Planning Center API, along with what is possible for each:

Check-Ins

Manage child and volunteer attendance
Create, update, and retrieve check-in records
Manage locations and events for check-ins

Giving

Process donations and generate reports
Create, update, and retrieve donation records
Manage donors and funds
Track donation history

Groups

Organize and communicate with community groups
Create, update, and retrieve group information
Manage group members and leaders

People

Manage church membership data
Create, update, and retrieve person records
Search for people based on various criteria
Handle person merges and updates

Calendar

Schedule events and manage facility bookings
Create, update, and retrieve event information
Manage resource bookings and availability

Services

Plan services and schedule volunteers
Create, update, and retrieve service plans
Manage volunteer schedules and assignments

General API Capabilities

Conform to JSON API 1.0 specification
Authenticate using OAuth
Use webhooks to receive real-time updates on data changes
Apply filters and pagination to API requests
Include related data in API responses

Best Practices

Use date range filters for large datasets to avoid performance issues
Handle person merges and updates properly in your integration
Implement proper error handling and retry mechanisms
Use webhooks to keep your data in sync with Planning Center

It's important to note that the Planning Center API provides a unified interface for interacting with these various data models across their different products. This allows for seamless integration and data management across the entire Planning Center ecosystem.