Skip to content

Open-source manufacturing ERP, MES and QMS. Quoting, MRP, inventory, shop floor, quality and lot/serial traceability on one Postgres schema, with a REST API and MCP server. Self-host or use Carbon Cloud.

docs(integrations): note Ramp bill and vendor limits, first-site linking, and Slack shortcut access

aashuc0fa42b2083b
diff --git a/docs/content/docs/integrations/setup/jira.mdx b/docs/content/docs/integrations/setup/jira.mdx
index b17aab6cdc..b22ed95ae9 100644
--- a/docs/content/docs/integrations/setup/jira.mdx
+++ b/docs/content/docs/integrations/setup/jira.mdx
@@ -26,8 +26,9 @@ webhook.
<Step>
### Allow Carbon in Jira
- Pick **one** Jira site and accept. Carbon links one site: the first one Atlassian
- lists for your login.
+ Pick **one** Jira site and accept. Carbon links the first site in Atlassian's
+ list. If your login approved Carbon for other sites before, that list can start
+ with one of them, so connect with a login that only has the site you want.
{/* Replace with /screens/setup-jira-consent.png */}
<Screenshot label="Atlassian's consent screen for Carbon, with the site picker and the Accept button" ratio="tall" />
@@ -96,6 +97,8 @@ On your own servers, you create the Atlassian app once:
1. Create an OAuth 2.0 integration in the
[Atlassian developer console](https://developer.atlassian.com/console/myapps/).
+ If someone other than its creator will connect it, turn on sharing under
+ **Distribution**.
2. Add the Jira API with `read:jira-user`, `read:jira-work` and `write:jira-work`.
3. Set the callback URL to `https://<your Carbon address>/api/integrations/jira/oauth`.
4. Set `JIRA_CLIENT_ID` and `JIRA_CLIENT_SECRET` in Carbon's environment, then
diff --git a/docs/content/docs/integrations/setup/ramp.mdx b/docs/content/docs/integrations/setup/ramp.mdx
index fd55e11e65..a99b6a0893 100644
--- a/docs/content/docs/integrations/setup/ramp.mdx
+++ b/docs/content/docs/integrations/setup/ramp.mdx
@@ -27,7 +27,14 @@ asks which system that is.
to Ramp and keeps posting the spend. Carbon only reads back which bills were paid.
In both modes, Carbon sends purchase orders and draft bills to Ramp, and creates
-their vendors there.
+their vendors there. Two things to know:
+
+- **Each draft bill is sent once.** If you change the invoice in Carbon afterwards,
+ update the bill in Ramp too.
+- **Suppliers need contact details.** To create a vendor in Ramp, a supplier needs a
+ contact email and a country on one of its locations (plus a state for US
+ suppliers). Without them, that supplier's bills don't reach Ramp. Carbon doesn't
+ update a vendor in Ramp when the supplier changes later.
## Connect Ramp
@@ -72,7 +79,7 @@ their vendors there.
| --- | :---: | :---: |
| Create and update purchase orders | ✓ | ✓ |
| Create draft bills, and see bills and their payments | ✓ | ✓ |
-| Create and update vendors | ✓ | ✓ |
+| Create vendors | ✓ | ✓ |
| See your business and its entities | ✓ | ✓ |
| See card transactions, receipts, reimbursements, repayments, transfers, cashback and statements | ✓ | |
| See Ramp's accounting connection and coding options | ✓ | ✓ |
@@ -128,6 +135,7 @@ vendors:write
| *Another system is connected to Ramp as its accounting system* | Your other accounting system already holds Ramp's one spot. Uninstall Ramp in Carbon, then connect again and pick **Another system posts my ledger**. Or disconnect the other system in Ramp, then open the Ramp integration in Carbon and save its settings. |
| *Ramp denied the connection* | Ramp refused access, for example because it was cancelled. Connect again and allow access, signed in as an Admin or Business Owner. |
| *The Ramp connection expired* | Carbon couldn't match this sign-in to one you started: it took over an hour, or finished in another browser or Carbon account. Start again from **Settings → Integrations**. |
+| A bill didn't reach Ramp, and **Sync Activity** says the supplier *needs a contact email*, *a country* or *a two-letter state* | Add the missing detail to the supplier in Carbon. The bill is retried on the next sync. |
| *Ramp connected but setup didn't finish* | Open the Ramp integration and save its settings to finish setup. If that fails too, uninstall Ramp and connect again. |
Picked the wrong answer to the first question? Uninstall Ramp in Carbon and
diff --git a/docs/content/docs/integrations/setup/slack.mdx b/docs/content/docs/integrations/setup/slack.mdx
index 11dbdfdc9e..6b8269bf84 100644
--- a/docs/content/docs/integrations/setup/slack.mdx
+++ b/docs/content/docs/integrations/setup/slack.mdx
@@ -7,7 +7,8 @@ description: Add the Carbon Assistant to your Slack workspace in three steps.
Connect Slack to use the Carbon Assistant in your Slack workspace.
**You need:** permission to change Settings in Carbon, and permission to add apps
-to your Slack workspace.
+to your Slack workspace. Slack isn't available on controlled (ITAR) Carbon
+deployments.
<Diagram name="connect" />
@@ -89,13 +90,16 @@ Skip this on Carbon Cloud. The Slack app is already set up.
On your own servers, you create the Slack app once:
-1. Create an app at [api.slack.com/apps](https://api.slack.com/apps).
+1. Create an app at [api.slack.com/apps](https://api.slack.com/apps), in the workspace
+ you'll connect. An app made in another workspace needs Slack's distribution turned
+ on before it can be installed elsewhere.
2. Add every permission from the list above as a **bot** permission.
3. Add this redirect URL: `https://<your Carbon address>/api/integrations/slack/oauth`.
4. Turn on interactivity, with this request URL:
`https://<your Carbon address>/api/integrations/slack/interactive`.
Add a global shortcut with the callback ID `create_ncr_modal`. It opens Carbon's
- **Create Issue** form.
+ **Create Issue** form. Anyone in the Slack workspace can use it, and Carbon
+ creates the issue without checking that person's Carbon permissions.
5. Set these in Carbon's environment, then restart Carbon:
| Variable | Value |
diff --git a/docs/content/docs/integrations/setup/xero.mdx b/docs/content/docs/integrations/setup/xero.mdx
index 9c3db10786..9527486114 100644
--- a/docs/content/docs/integrations/setup/xero.mdx
+++ b/docs/content/docs/integrations/setup/xero.mdx
@@ -26,8 +26,10 @@ company as on your Xero organisation.
<Step>
### Allow Carbon in Xero
- Sign in to Xero, pick **one** organisation and allow access. Carbon links one
- organisation: the first one Xero lists for your login.
+ Sign in to Xero, pick **one** organisation and allow access. Carbon links the
+ first organisation in Xero's list. If you connected other organisations to Carbon
+ before, that list can start with one of them. After connecting, open the Xero
+ integration and check the name next to **Connected to**.
{/* Replace with /screens/setup-xero-consent.png */}
<Screenshot label="Xero's consent screen for Carbon, with the organisation picker and the Allow access button" ratio="tall" />
@@ -89,7 +91,8 @@ On your own servers, you create the Xero app once:
3. For live updates from Xero, add a webhook to
`https://<your Carbon address>/api/webhook/xero` for contacts and invoices, and set
its key as `XERO_WEBHOOK_SECRET`.
-4. Restart Carbon.
+4. Restart Carbon. Then run Xero's "Intent to receive" check on the webhook; Xero
+ sends no updates until it passes.
{/* Replace with /screens/setup-xero-app.png */}
<Screenshot label="Xero developer portal, the Carbon app's configuration with its redirect URI" />