feat(integrations): add support for Pushpay ChMS V2 - #7011
Open
chrisShick wants to merge 3 commits into
Open
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Update branch with master
Feat(integrations) pushpay chms v2
hassan254-prog
left a comment
Contributor
There was a problem hiding this comment.
Thank you for the contribution, few comments inline otherwise looks good.
Comment on lines
+16967
to
+16971
| paginate: | ||
| type: offset | ||
| offset_name_in_request: page | ||
| offset_start_value: 1 | ||
| limit_name_in_request: per_page |
Contributor
There was a problem hiding this comment.
I would remove this here and let it defined within the functions.
| Ask Pushpay / Church Community Builder to register the Nango callback URL on your OAuth application. The redirect URI domain must match what they configured for your app. | ||
|
|
||
| - **Nango Cloud**: `https://api.nango.dev/oauth/callback` | ||
| - **Local Docker**: `http://localhost:3003/oauth/callback` |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Local Docker**: `http://localhost:3003/oauth/callback` |
only mention the Nango cloud redirect url.
Comment on lines
+28
to
+36
| #### Step 2: Authorize the connection | ||
|
|
||
| 1. Open the Nango Connect form for Pushpay ChMS (v2). | ||
| 2. Enter the **Church subdomain**. | ||
| 3. Continue to Pushpay's authorization page. | ||
| 4. Sign in as a Master Administrator (or a user who can edit system-wide settings) if prompted. | ||
| 5. Review the requested scopes and approve access for the vendor application. | ||
|
|
||
| You are now connected to Pushpay ChMS (v2). API calls go to `https://api.ccbchurch.com` using the OAuth access token Nango stores for the connection. |
Contributor
There was a problem hiding this comment.
For this step I would use the exact same wording as with the other docs, also include the nango form screenshot.
| Church subdomain and authorization requirements | ||
|
|
||
| Official partner form: [Become a value-added partner](https://vendor.ccbchurch.com/goto/forms/12/responses/new) | ||
|
|
Contributor
There was a problem hiding this comment.
Please include their official docs link here as well.
|
|
||
| - All API calls use `https://api.ccbchurch.com` (not `https://{subdomain}.ccbchurch.com`). | ||
| - Nango sends `Accept: application/vnd.ccbchurch.v2+json` on proxied requests. | ||
| - Access tokens expire in about **7200 seconds** and are refreshed with the church `subdomain`. |
Contributor
There was a problem hiding this comment.
Suggested change
| - Access tokens expire in about **7200 seconds** and are refreshed with the church `subdomain`. |
| - Nango sends `Accept: application/vnd.ccbchurch.v2+json` on proxied requests. | ||
| - Access tokens expire in about **7200 seconds** and are refreshed with the church `subdomain`. | ||
| - This integration uses **System Auth** (church administrator authorizes your vendor app). Identity Auth (`resource_owner_auth`) is a separate flow for acting as an individual after System Auth is already granted. | ||
| - List endpoints typically support `page` and `per_page` (25, 50, 75, or 100) and return pagination headers such as `X-Page` and `X-Total-Pages`. |
Contributor
There was a problem hiding this comment.
Suggested change
| - List endpoints typically support `page` and `per_page` (25, 50, 75, or 100) and return pagination headers such as `X-Page` and `X-Total-Pages`. |
| ## API notes | ||
|
|
||
| - All API calls use `https://api.ccbchurch.com` (not `https://{subdomain}.ccbchurch.com`). | ||
| - Nango sends `Accept: application/vnd.ccbchurch.v2+json` on proxied requests. |
Contributor
There was a problem hiding this comment.
Suggested change
| - Nango sends `Accept: application/vnd.ccbchurch.v2+json` on proxied requests. |
| description: The subdomain for the Pushpay ChMS (Church Community Builder) site to authorize. | ||
| example: yourchurch | ||
| pattern: '^[a-zA-Z0-9-]+$' | ||
| order: 1 |
Contributor
There was a problem hiding this comment.
Suggested change
| order: 1 |
| secret: true | ||
| doc_section: '#step-2-create-an-api-user' | ||
|
|
||
| pushpay-chms-v2: |
Contributor
There was a problem hiding this comment.
I would rename this to pushpay-chms-oauth instead.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding support for Pushpay ChMS V2