Revert "Revert "[CON-3211] feat(acculynx): extend provider guide with Read, Write, and Subscribe Actions""#634
Open
laurenzlong wants to merge 3 commits into
Open
Conversation
…e, and S…" This reverts commit 4f27e92.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Beyond create/update on contacts and jobs, AccuLynx publishes additional jobs change topics (financials, appointments, category, trade/work-type) that can be subscribed to via otherEvents. Link AccuLynx's webhook topics reference for the full list.
anushat05
requested changes
Jul 1, 2026
| - [users](https://apidocs.acculynx.com/reference/users) (read only) | ||
|
|
||
| <Note> | ||
| Writes to top-level `jobs` and `contacts` (and all nested `jobs/*` and `contacts/*` write endpoints except custom-fields) are **create-only** — AccuLynx does not expose update endpoints for these records. Writes to `contacts/custom-fields` and `jobs/custom-fields` are **update-only**; AccuLynx does not expose an API to create, update, or delete custom field definitions themselves. Deletes are supported only on `jobs/representatives/ar-owner` and `jobs/representatives/sales-owner` (clearing the rep slot on a job). |
Contributor
There was a problem hiding this comment.
This change improves readability by:
- Breaking the dense Note into two clear bullets (Create-only / Update-only)
- Separating the Custom fields and Subscribe events sections with bold lead-ins
Dropping the Delete sentence: The original Note mentioned "Deletes are supported only on jobs/representatives/ar-owner and jobs/representatives/sales-owner", but Delete actions are not actually enabled in the provider configuration. If Delete support needs to be added in the future, it should first be enabled in the provider info, then documented here.
Suggested change
| Writes to top-level `jobs` and `contacts` (and all nested `jobs/*` and `contacts/*` write endpoints except custom-fields) are **create-only** — AccuLynx does not expose update endpoints for these records. Writes to `contacts/custom-fields` and `jobs/custom-fields` are **update-only**; AccuLynx does not expose an API to create, update, or delete custom field definitions themselves. Deletes are supported only on `jobs/representatives/ar-owner` and `jobs/representatives/sales-owner` (clearing the rep slot on a job). | |
| <Note> | |
| **Writes are limited by AccuLynx's API:** | |
| - **Create-only:** `jobs`, `contacts`, and their nested write endpoints (except custom-fields) — AccuLynx has no update endpoints for these records. | |
| - **Update-only:** `contacts/custom-fields` and `jobs/custom-fields` — you can change a custom field's value, but cannot create, update, or delete the field definitions themselves. | |
| </Note> | |
| **Custom fields** defined in AccuLynx are automatically discovered and surfaced on `contacts` and `jobs` records. | |
| **Subscribe events** for create and update are first-class on `contacts` and `jobs`. The other 6 subscribe-tagged objects above — plus extra `jobs` change topics (financial, appointment, category, trade/work-type, and more) — are subscribed via [`otherEvents`](/subscribe-actions#other-events) under the parent `contacts` or `jobs` object in your `amp.yaml`. See AccuLynx's [webhook topics reference](https://apidocs.acculynx.com/reference/gettopics) for the full list. |
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
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.
Reverts #633