DOCS: Document the CleverReach group-fetch hooks - #19
Open
dhrupo wants to merge 1 commit into
Open
Conversation
Both hooks ship with the CleverReach resubscribe work in fluentformpro PR #278 and were undocumented. fluentform/cleverreach_groups_pagination tunes how the feed settings dropdown fetches the account's groups. Worth documenting because the fetch is deliberately additive -- CleverReach documents no paging on /v3/groups -- and because probe_from below 1 is the supported way back to a single unpaged request. fluentform/cleverreach_groups_fetch_incomplete fires when that fetch came back short, which is otherwise indistinguishable from a small account. The note records which endings count as degraded and which are ordinary, so a listener does not fire on healthy sites. Refs: https://lounge.authlab.io/projects#/boards/16/tasks/22501-CleverReach-resubscribe-flow-i
Deploying fluentform-developers with
|
| Latest commit: |
caf806f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0d052f65.fluentform-developers.pages.dev |
| Branch Preview URL: | https://docs-cleverreach-integration.fluentform-developers.pages.dev |
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
1 participant
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.
What does this PR do and why?
Two hooks ship with the CleverReach resubscribe work in fluentformpro#278 and are undocumented. This adds both to the integration hook pages.
fluentform/cleverreach_groups_paginationtunes how the feed settings dropdown fetches an account's groups. It needs documenting because the fetch is deliberately additive — CleverReach documents no paging on/v3/groups, so the first request carries no paging parameters and further pages are only probed when a response looks capped — and becauseprobe_frombelow1is the supported way back to a single unpaged request.fluentform/cleverreach_groups_fetch_incompletefires when that fetch came back short, which is otherwise indistinguishable from an account that genuinely has few lists. The entry records which endings count as degraded (API error, exception, unreadable rows,max_pagesreached) and which are ordinary (short final page, paging ignored), so a listener does not fire on healthy sites.Related issue: https://lounge.authlab.io/projects#/boards/16/tasks/22501-CleverReach-resubscribe-flow-i
Changes
src/hooks/filters/integration.md— addsfluentform/cleverreach_groups_paginationwith both config keys, their defaults, and two usage examples.src/hooks/actions/integration.md— addsfluentform/cleverreach_groups_fetch_incompletewith its three arguments and when it does and does not fire.Both are placed alphabetically and carry the
Probadge, matching the surrounding entries.How to test
npm run build— completes clean (verified).src/.vuepress/dist/hooks/filters/integration/index.htmland.../actions/integration/index.htmlrespectively.Anything the reviewer should know?
Two things I noticed but deliberately left alone:
src/hooks/filters/integration.mdreads "27 Filters" but the page had 36 entries before this PR (4 of them Pro-badged), so neither a total nor a free-only reading explains 27. I did not bump or correct it, since I could not tell what it is meant to count. Worth a separate fix once the intent is settled.fluentform/mailerlite_groups_paginationis the same pattern in the same file and is also undocumented. Left out to keep this PR to the hooks it ships with — happy to add it here or separately.