| Add-on |
This term is almost synonymous with an OAuth Application, but specifically denotes an OAuth Application that also has UI Extensions rendered by Planning Center. |
| Add-on Scopes |
These are the OAuth scopes that the add-on will request on behalf of the user in order to get an API token that does what your add-on needs. (These are separate and may be different than the scopes needed by your OAuth Application proper.) These add-on scopes are configured in the config.yaml file described later in this document. |
| Component |
A React Component is a single class or function that controls a portion of the user interface for your add-on. Larger components can and often are made of smaller components and layered in a way to make the composition easy-to-understand and allow reuse of common bits of UI. |
| Insertion Point |
This is a point in a specific Planning Center product where a UI Extension will get rendered. It is up to each Planning Center product team to implement these points in places where add-on authors wish to present their own UI. |
| Integrator |
This is you! If you are a company or individual building an add-on for Planning Center, then you are an "Integrator" with us. We'll use this term in some of the later sections and even code to differentiate your stuff vs ours. |
| OAuth Application |
The application configured at https://api.planningcenteronline.com/oauth/applications listing your app's name, description, URL, callback URLs, etc. This allows your application code to make requests to the Planning Center API. |
| OAuth Server |
The server that our system uses to talk to your API. It must conform to the OAuth2 specification and allow Planning Center to obtain a token for use by your add-on JavaScript. This allows Planning Center to make requests to your (the Integrator's) API on behalf of your add-on. |
| UI Extension |
The React component (written in JavaScript) that is rendered by Planning Center and shown in the UI. Each add-on has one or more UI Extensions. |
| Web Worker |
A Web Worker is a separate thread of JavaScript execution in the web browser, separate from the main thread that most other scripts execute inside. Planning Center add-ons execute in a Web Worker and thus have no access to the DOM directly. |