+
+
+
+
+
+For objects and fields, you can also use Ampersand’s [Object Metadata APIs](/reference/objects-&-fields/get-object-metadata-via-connection) to inspect what’s available for a specific connection.
+
+### Notes and limitations
+
+- **Published vs draft positions**: Write **create** leaves new positions in **draft**. The `positions` Read object returns **published** job postings only. The connector does **not** auto-publish on create. When the customer is ready to go live, publish via [Proxy Actions](/proxy-actions): `PUT /v3/company/{company_id}/position/{position_id}/state` with `{"state":"published"}`. Until published, the job will not appear in Read webhooks. Publish is intentional — Breezy does not support unpublishing.
+- **Incremental read**: Incremental read is supported for `positions` only (filtered by `updated_date`). Scheduled reads emit only positions updated since the last sync. `companies`, `pipelines`, `categories`, `departments`, `questionnaires`, and `templates` are read in full on each scheduled read.
+- **Pipelines**: Breezy returns a map of pipeline id → pipeline object (e.g. `default`, `default_pool`).
+- **API key expiry**: Breezy access tokens from `/v3/signin` expire after approximately 30 days.
+
+### Example integration
+
+To define an integration for Breezy, use a manifest file (`amp.yaml`). For a complete example, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/breezy/amp.yaml).
+
+## Before you get started
+
+To connect _Breezy_ with _Ampersand_, you will need [a Breezy account](https://breezy.hr/).
+
+Once your account is created, you'll need to obtain an **API Key** — a Breezy access token used as the `Authorization` header on API requests.
+
+Your customers enter this when they install the integration via the InstallIntegration UI.
+
+### Create a Breezy account
+
+Here's how you can sign up for a Breezy account:
+
+- Sign up at [Breezy](https://breezy.hr/).
+
+### Obtain API credentials
+
+Follow the steps below to obtain your API key from Breezy:
+
+1. Call Breezy's [sign-in endpoint](https://developer.breezy.hr/reference/signin) with a user that has API access. See [Authorization](https://developer.breezy.hr/reference/authorization).
+
+ ```bash
+ curl -H "Content-Type: application/json" \
+ -X POST \
+ -d '{"email":"user@example.com","password":"YOUR_PASSWORD"}' \
+ https://api.breezy.hr/v3/signin
+ ```
+
+ Use the `access_token` value from the response as the API key.
+
+## Using the connector
+
+This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)
+
+The API key is sent in the `Authorization` header with no prefix, per [Breezy’s documentation](https://developer.breezy.hr/reference/authorization).
+
+To start integrating with Breezy:
+- Create a manifest file; see [Example integration](#example-integration).
+- Deploy it using the [amp CLI](/cli/overview).
+- If you are using Read Actions, create a [destination](/destinations).
+- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their API key.
+- Start using the connector!
+ - If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
+ - If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
+ - If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls. Ampersand will automatically attach the API key for the connected account.
diff --git a/src/provider-guides/callRail.mdx b/src/provider-guides/callRail.mdx
new file mode 100644
index 00000000..5def0fb4
--- /dev/null
+++ b/src/provider-guides/callRail.mdx
@@ -0,0 +1,143 @@
+---
+title: "CallRail"
+description: "Connect CallRail to Ampersand with an API key, then use read, write, and proxy actions across calls, companies, form submissions, leads, and notifications."
+---
+
+## What's supported
+
+### Supported actions
+
+This connector supports:
+- [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported, a full read of the CallRail instance will be done for each scheduled read.
+- [Write Actions](/write-actions).
+- [Proxy Actions](/proxy-actions), using the base URL `https://api.callrail.com`.
+- Subscribe Actions are not currently supported.
+
+### Supported objects
+
+export const rows = [
+ {
+ label: "caller_ids", read: "no", write: true,
+ href: "https://apidocs.callrail.com/#outbound-caller-ids",
+ }, {
+ label: "calls", read: true, write: true,
+ href: "https://apidocs.callrail.com/#calls",
+ },{
+ label: "companies", read: true, write: true,
+ href: "https://apidocs.callrail.com/#companies",
+ }, {
+ label: "form_submissions", read: true, write: true,
+ href: "https://apidocs.callrail.com/#form-submissions",
+ }, {
+ label: "integration_triggers", read: "no", write: true,
+ href: "https://apidocs.callrail.com/#integration-filters",
+ }, {
+ label: "integrations", read: "no", write: true,
+ href: "https://apidocs.callrail.com/#integrations",
+ }, {
+ label: "leads", read: true, write: "no",
+ href: "https://apidocs.callrail.com/#leads",
+ }, {
+ label: "message-flows", read: true, write: true,
+ href: "https://apidocs.callrail.com/#message-flows",
+ }, {
+ label: "notifications", read: true, write: true,
+ href: "https://apidocs.callrail.com/#notifications",
+ }, {
+ label: "sms-threads", read: true, write: true,
+ href: "https://apidocs.callrail.com/#sms-threads",
+ }, {
+ label: "summary_emails", read: true, write: true,
+ href: "https://apidocs.callrail.com/#summary-emails",
+ }, {
+ label: "tags", read: true, write: true,
+ href: "https://apidocs.callrail.com/#tags",
+ }, {
+ label: "text-messages", read: true, write: true,
+ href: "https://apidocs.callrail.com/#text-messages",
+ }, {
+ label: "trackers", read: true, write: true,
+ href: "https://apidocs.callrail.com/#trackers",
+ }, {
+ label: "users", read: true, write: true,
+ href: "https://apidocs.callrail.com/#users",
+ },
+]
+
+export const Check = () => ✅
+export const Cross = () => 🚫
+
+export function renderCellValue(value) {
+ if (value === true) {
+ return | Object | +Read | +Write | +Subscribe | +
|---|---|---|---|
| + {row.label} + | +{renderCellValue(row.read)} | +{renderCellValue(row.write)} | +{renderCellValue(row.subscribe)} | +
+
+
+
+
+
+
+### Example integration
+
+For an example manifest file of a CallRail integration, visit our [samples repo on GitHub](https://github.com/amp-labs/samples/blob/main/callrail/amp.yaml).
+
+## Before you get started
+
+To connect CallRail with Ampersand, you will need a [CallRail account](https://www.callrail.com/).
+
+### Creating an API key for CallRail
+
+1. Log in to your [CallRail account](https://app.callrail.com/).
+2. Go to **Account Settings**, then select **API Keys** under **Data Access**.
+3. Select **Create New API v3 Key** and give the key a name.
+4. Copy the key and store it somewhere secure — CallRail displays it only once. See [CallRail's API](https://support.callrail.com/hc/en-us/articles/5711821845389-CallRail-s-API) for more detail.
+
+Your customers enter this API key when they install the integration. Ampersand sends it as `Authorization: Token token=| Object | +Read | +Write | +
|---|---|---|
| + {row.label} + | +{renderCellValue(row.read)} | +{renderCellValue(row.write)} | +
+
+
+
+
+
+### Example integration
+
+For an example manifest file of a Lob integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/lob/amp.yaml).
+
+## Using the connector
+
+This connector uses Basic Auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)
+
+To start integrating with Lob:
+- Create a manifest file like the example above.
+- Deploy it using the [amp CLI](/cli/overview).
+- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their username and password.
+- Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the correct header required by Basic Auth. Please note that this connector's base URL is `https://api.lob.com`.
+
+## Credential format for Lob
+
+Lob uses HTTP Basic Authentication with a non-standard credential format.
+The fields in the installation UI do not correspond to a Lob account email address and password. Instead:
+- **Username**: Enter the Lob API key from the [Lob Dashboard API key settings](https://dashboard.lob.com/settings/api-keys).
+- **Password**: Leave this field empty.
+
+When making proxy calls, Ampersand encodes these values as a Basic Auth header and attaches it automatically.
+Choose the API key appropriate for the environment you are integrating with. For example, choose
+a **test key** for Lob’s test environment and a **live key** for production use.
+
+For more detail, see [Lob's authentication documentation](https://docs.lob.com/#tag/Authentication)
+and [API key documentation](https://docs.lob.com/#tag/Authentication/API-Keys).
diff --git a/src/provider-guides/monaco.mdx b/src/provider-guides/monaco.mdx
new file mode 100644
index 00000000..e8fbcda0
--- /dev/null
+++ b/src/provider-guides/monaco.mdx
@@ -0,0 +1,43 @@
+---
+title: Monaco
+description: "Connect Monaco to Ampersand with an API key and call any Monaco API endpoint through proxy actions, with the API key attached automatically to every request."
+---
+## What's supported
+
+### Supported actions
+
+This connector supports:
+- [Proxy Actions](/proxy-actions), using the base URL `https://api.monaco.com`.
+
+### Example integration
+
+To define an integration for Monaco, create a manifest file that looks like this:
+
+```YAML
+# amp.yaml
+specVersion: 1.0.0
+integrations:
+ - name: monaco-integration
+ displayName: My Monaco Integration
+ provider: monaco
+ proxy:
+ enabled: true
+```
+
+## Using the connector
+
+This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)
+
+To start integrating with Monaco:
+- Create a manifest file like the example above.
+- Deploy it using the [amp CLI](/cli/overview).
+- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for an API key.
+- Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the API key supplied by the customer. Please note that this connector's base URL is `https://api.monaco.com`.
+
+## Creating an API key for Monaco
+
+1. Log in to your Monaco account.
+2. Navigate to **Settings** and select **API Keys**.
+3. Create a new key and copy its value. Monaco API keys are prefixed with `mks_`.
+
+[Click here](https://docs.monaco.com/auth) for more information about generating an API key for Monaco. The UI components will display this link, so that your users can successfully create API keys.
diff --git a/src/provider-guides/pipedrive.mdx b/src/provider-guides/pipedrive.mdx
index 4c887af9..a1a6bca7 100644
--- a/src/provider-guides/pipedrive.mdx
+++ b/src/provider-guides/pipedrive.mdx
@@ -1,5 +1,6 @@
---
title: "Pipedrive"
+description: "Connect Pipedrive to Ampersand using OAuth, choose the CRM v2 or legacy v1 API module, and use read, write, and proxy actions across deals and persons."
slug: "pipedrive"
excerpt: ""
hidden: false
@@ -13,11 +14,11 @@ updatedAt: "Mon Jul 15 2024 15:56:36 GMT+0000 (Coordinated Universal Time)"
This connector supports:
-- [Read Actions](/read-actions) including full historic backfill. Incremental read is supported for select objects using the v2 API (see [v2 API Objects](#v2-api-objects) below). For all other objects, a full read of the Pipedrive instance will be done for each scheduled read.
+- [Read Actions](/read-actions) including full historic backfill. Incremental read is supported for select objects using the v2 API (see [v2 API Objects](#supported-objects-for-v2-api) below). For all other objects, a full read of the Pipedrive instance will be done for each scheduled read.
- [Write Actions](/write-actions)
- [Proxy Actions](/proxy-actions), using the base URL `https://api.pipedrive.com`.
-Pipedrive has a v1 and v2 API, if you would like to opt into the v2 API, then add `module: crm` to your amp.yaml file. Otherwise, v1 API is used. You can learn more about the difference between v1 and v2 API in [Pipedrive documentation](https://pipedrive.readme.io/docs/pipedrive-api-v2-migration-guide).
+Pipedrive has a v1 and v2 API, if you would like to opt into the v2 API, then add `module: crm` to your amp.yaml file. If you would like to use v1 API, add `module: legacy` to your amp.yaml file. If you do not specify a module, v1 API is used. You can learn more about the difference between v1 and v2 API in [Pipedrive documentation](https://pipedrive.readme.io/docs/pipedrive-api-v2-migration-guide).
```yaml
specVersion: 1.0.0
@@ -83,6 +84,7 @@ The Pipedrive connector supports reading from the following objects using the v1
- [Lead Labels](https://developers.pipedrive.com/docs/api/v1/LeadLabels#getLeadLabels)
- [Lead Sources](https://developers.pipedrive.com/docs/api/v1/LeadSources#getLeadSources)
- [LegacyTeams](https://developers.pipedrive.com/docs/api/v1/LegacyTeams#getTeams)
+- [Mail Threads](https://developers.pipedrive.com/docs/api/v1/Mailbox#getMailThreads) (use `mailThreads` in amp.yaml, no incremental read)
- [Notes](https://developers.pipedrive.com/docs/api/v1/Notes#getNotes)
- [Note Fields](https://developers.pipedrive.com/docs/api/v1/NoteFields#getNoteFields)
- [Organizations](https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizations)
diff --git a/src/provider-guides/reply.mdx b/src/provider-guides/reply.mdx
new file mode 100644
index 00000000..b60c943a
--- /dev/null
+++ b/src/provider-guides/reply.mdx
@@ -0,0 +1,55 @@
+---
+title: "Reply"
+description: "Connect Reply.io to Ampersand with an API key, then call any Reply API endpoint through proxy actions with your permissioned key attached to each request."
+---
+
+## What's supported
+
+### Supported actions
+
+This connector supports:
+
+- [Proxy Actions](/proxy-actions), using the base URL `https://api.reply.io`.
+
+### Example integration
+
+To define an integration for Reply, create a manifest file that looks like this:
+
+```YAML
+# amp.yaml
+specVersion: 1.0.0
+integrations:
+ - name: replyIntegration
+ displayName: My Reply Integration
+ provider: reply
+ proxy:
+ enabled: true
+```
+
+## Before you get started
+
+To connect Reply with Ampersand, you will need a [Reply account](https://reply.io/). Reply offers a free trial that includes API access.
+
+### Creating an API key for Reply
+
+1. Sign in to your [Reply account](https://run.reply.io).
+2. Go to **Settings**, then select **API keys**.
+3. Click **Create My API key** and enter a descriptive name for the key.
+4. Leave the expiration date empty for a key that never expires, or set a date to make the key expire.
+5. Set the permission sliders to cover the scopes that your integration needs. The sliders default to **None**, and a key created without permissions returns `401 Unauthorized` on every request.
+6. Click **Create key**, then copy the key.
+
+
+
+[Click here](https://docs.reply.io/api-reference/authentication) for more information about generating an API key for Reply. The UI components will display this link, so that your users can successfully create API keys.
+
+## Using the connector
+
+This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)
+
+To start integrating with Reply:
+
+- Create a manifest file like the [example above](#example-integration).
+- Deploy it using the [amp CLI](/cli/overview).
+- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their API key.
+- Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the correct header required by API Key auth. Please note that this connector's base URL is `https://api.reply.io`.
diff --git a/src/provider-guides/salesforce.mdx b/src/provider-guides/salesforce.mdx
index 1c3b883e..18cd081a 100644
--- a/src/provider-guides/salesforce.mdx
+++ b/src/provider-guides/salesforce.mdx
@@ -1,5 +1,6 @@
---
title: "Salesforce"
+description: "Connect Salesforce CRM and Account Engagement to Ampersand using OAuth, then use read, write, proxy, and subscribe actions across CRM objects."
---
The Salesforce connector supports:
@@ -15,7 +16,7 @@ This connector has two modules, with CRM as the default.
The **CRM** module supports:
- [Proxy Actions](/proxy-actions), using the base URL `https://{{.workspace}}.my.salesforce.com`.
- [Read Actions](/read-actions), including full historic backfill, incremental read, and filters.
-- [Subscribe Actions](/subscribe-actions). See [Quota optimization for Subscribe Actions](#quota-optimization-for-subscribe-actions) to reduce CDC / platform event quota usage.
+- [Subscribe Actions](/subscribe-actions).
- [Write Actions](/write-actions), including Bulk Write and Delete.
The **Account Engagement** module supports:
@@ -375,7 +376,7 @@ The UI library will not prompt your users to install the package, you must indep
## Migrating Connected App to External Client App
-Salesforce no longer supports the creation of new Connected Apps. If you had previously created a Connected App to be used for Ampersand integrations, it will continue to work for your existing and new customers as long as their user profile has the `Approve Uninstalled Connected Apps` or `Use Any API Client` permissions. See [Salesforce customer guide](/customer-guides/salesforce#1-view-and-edit-permissions-for-profile) for details.
+Salesforce no longer supports the creation of new Connected Apps. If you had previously created a Connected App to be used for Ampersand integrations, it will continue to work for your existing and new customers as long as their user profile has the `Approve Uninstalled Connected Apps` or `Use Any API Client` permissions. See [Salesforce customer guide](/customer-guides/salesforce#required-system-permissions) for details.
Whenever you would like to, you can follow these steps to migrate a Connected App to an External Client App:
@@ -431,92 +432,6 @@ To start integrating with Salesforce:
- If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
- If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.
-## Quota optimization for Subscribe Actions
-
-Quota optimization is an opt-in feature for [Subscribe actions](/subscribe-actions). It limits update events to the fields you care about, so irrelevant changes are filtered out at the source and do not count against Salesforce's shared [daily delivery allocation for Change Data Capture (CDC) and platform events](https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_allocations.htm) (`DailyDeliveredPlatformEvents`) — a rolling 24-hour limit on how many events can be delivered to API subscribers.
-
-### How it works
-
-Salesforce CDC does not natively support fine-grained field-level filtering in a way that avoids using that allocation. Ampersand adds an optimization layer on each opted-in object:
-
-1. A custom checkbox field is created on the object.
-2. An Apex trigger is created that sets this field when a watched field changes.
-3. CDC is configured to emit events only when this checkbox field is `true`.
-
-As a result, update events are delivered only when meaningful changes occur.
-
-### What is created in Salesforce
-
-When quota optimization is enabled for an object, Ampersand creates the following artifacts in the customer's Salesforce org:
-
-**Custom checkbox field**
-
-- API name: `| Object | +Read | +Write | +Subscribe | +
|---|---|---|---|
| + {row.label} + | +{renderCellValue(row.read)} | +{renderCellValue(row.write)} | +{renderCellValue(row.subscribe)} | +
+
+
+
+
+
+### Choose a connector
+
+Use the **Bot connector** (`slack`) when your integration needs to operate with Slack bot token scopes.
+This is the typical choice for integrations that act as an installed Slack app or bot.
+
+Use the **User connector** (`slackUserScope`) when your integration needs to use Slack user token scopes
+and perform actions on behalf of the authorizing Slack user.
### Example integration
-For an example manifest file of a Slack integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/slack/amp.yaml).
+For an example manifest file of a Slack integration, visit our [samples repo on Github](https://github.com/amp-labs/samples).
+Use the sample corresponding to the connector you want to install:
+| Connector | Provider name | Example manifest |
+|----------------|------------------|--------------------------------------------------------------------------------------------|
+| Bot connector | `slack` | [Bot connector sample](https://github.com/amp-labs/samples/blob/main/slack/amp.yaml) |
+| User connector | `slackUserScope` | [User connector sample](https://github.com/amp-labs/samples/blob/main/slack-user/amp.yaml) |
+The two manifests use different provider names.
## Before you get started
@@ -54,7 +295,7 @@ Once your account is created, you'll need to create an app in Slack, configure t
- Client ID
- Client Secret
-- Bot scopes (user scopes are currently not supported)
+- **Bot scopes** and/or **User scopes**
You will then use these credentials to connect your application to Ampersand.
@@ -83,7 +324,7 @@ Follow the steps below to create a Slack app and add the Ampersand redirect URL.
7. Click **Add** and then **Save URLs**.
-8. In the **Scopes** section, add the necessary **Bot Token Scopes** for your app by clicking on **Add an OAuth Scope** and selecting the required scopes. **User Token Scopes are currently not supported.**
+8. In the **Scopes** section, add the necessary **Bot Token Scopes**/**User Token Scopes** for your app by clicking on **Add an OAuth Scope** and selecting the required scopes.
@@ -99,11 +340,11 @@ Follow the steps below to create a Slack app and add the Ampersand redirect URL.
3. Select **Provider Apps**.
-4. Select **Slack** from the **Provider** list.
+4. Select **Slack Bot Scope** or **Slack User Scope** from the **Provider** list.
5. Enter the previously obtained **Client ID** in the **Client ID** field and the **Client Secret** in the **Client Secret** field.
-6. Enter the **bot scopes** set for your application in _Slack_.
+6. Enter the **bot scopes** or **user scopes** set for your application in _Slack_.
diff --git a/src/provider-guides/square.mdx b/src/provider-guides/square.mdx
index 320eea4d..1dc788b5 100644
--- a/src/provider-guides/square.mdx
+++ b/src/provider-guides/square.mdx
@@ -1,5 +1,6 @@
---
title: "Square"
+description: "Connect Square to Ampersand using OAuth, then use read, write, and proxy actions across customers, orders, payments, catalog, and bookings."
---
## What's supported
diff --git a/src/provider-guides/stripe.mdx b/src/provider-guides/stripe.mdx
index 8d583a41..8e5df242 100644
--- a/src/provider-guides/stripe.mdx
+++ b/src/provider-guides/stripe.mdx
@@ -1,5 +1,6 @@
---
title: Stripe
+description: "Connect Stripe to Ampersand with an API key, then use read, write, subscribe, and proxy actions across charges, customers, invoices, and subscriptions."
---
## What's supported
@@ -12,113 +13,436 @@ The Stripe connector supports:
### Supported Objects
-The Stripe connector supports reading from and writing to the following objects:
-* [accounts](https://docs.stripe.com/api/accounts/object) (incremental read supported)
-* apple_pay/domains (Apple Pay Domains)
-* [billing/alerts](https://docs.stripe.com/api/billing/alert/object)
-* [billing/credit_grants](https://docs.stripe.com/api/billing/credit-grant/object)
-* [billing/meters](https://docs.stripe.com/api/billing/meter/object)
-* [billing_portal/configurations](https://docs.stripe.com/api/customer_portal/configurations/object)
-* [charges](https://docs.stripe.com/api/charges/object) (incremental read supported)
-* [checkout/sessions](https://docs.stripe.com/api/checkout/sessions/object) (incremental read supported)
-* [climate/orders](https://docs.stripe.com/api/climate/order/object)
-* [coupons](https://docs.stripe.com/api/coupons/object) (incremental read supported)
-* [credit_notes](https://docs.stripe.com/api/credit_notes/object) (incremental read supported)
-* [customers](https://docs.stripe.com/api/customers/object) (incremental read supported)
-* [disputes](https://docs.stripe.com/api/disputes/object) (incremental read supported)
-* [entitlements/features](https://docs.stripe.com/api/entitlements/feature/object)
-* [file_links](https://docs.stripe.com/api/file_links/object) (incremental read supported)
-* [files](https://docs.stripe.com/api/files/object) (incremental read supported)
-* [forwarding/requests](https://docs.stripe.com/api/forwarding/request/object) (incremental read supported)
-* [identity/verification_sessions](https://docs.stripe.com/api/identity/verification_sessions/object) (incremental read supported)
-* [invoiceitems](https://docs.stripe.com/api/invoiceitems/object) (incremental read supported)
-* [invoices](https://docs.stripe.com/api/invoices/object) (incremental read supported)
-* [issuing/authorizations](https://docs.stripe.com/api/issuing/authorizations/object) (incremental read supported)
-* [issuing/cardholders](https://docs.stripe.com/api/issuing/cardholders/object) (incremental read supported)
-* [issuing/cards](https://docs.stripe.com/api/issuing/cards/object) (incremental read supported)
-* [issuing/disputes](https://docs.stripe.com/api/issuing/disputes/object) (incremental read supported)
-* [issuing/personalization_designs](https://docs.stripe.com/api/issuing/personalization_designs/object)
-* [issuing/transactions](https://docs.stripe.com/api/issuing/transactions/object) (incremental read supported)
-* [payment_intents](https://docs.stripe.com/api/payment_intents/object) (incremental read supported)
-* [payment_links](https://docs.stripe.com/api/payment-link/object)
-* [payment_method_configurations](https://docs.stripe.com/api/payment_method_configurations/object)
-* [payment_method_domains](https://docs.stripe.com/api/payment_method_domains/object)
-* [payment_methods](https://docs.stripe.com/api/payment_methods/object)
-* [payouts](https://docs.stripe.com/api/payouts/object) (incremental read supported)
-* [plans](https://docs.stripe.com/api/plans/object) (incremental read supported)
-* [prices](https://docs.stripe.com/api/prices/object) (incremental read supported)
-* [products](https://docs.stripe.com/api/product-feature/object) (incremental read supported)
-* [promotion_codes](https://docs.stripe.com/api/promotion_codes/object) (incremental read supported)
-* [quotes](https://docs.stripe.com/api/quotes/object)
-* [radar/value_lists](https://docs.stripe.com/api/radar/value_lists/object) (incremental read supported)
-* [refunds](https://docs.stripe.com/api/refunds/object) (incremental read supported)
-* [reporting/report_runs](https://docs.stripe.com/api/reporting/report_run/object) (incremental read supported)
-* [setup_intents](https://docs.stripe.com/api/setup_intents/object) (incremental read supported)
-* [shipping_rates](https://docs.stripe.com/api/shipping_rates/object) (incremental read supported)
-* [subscription_schedules](https://docs.stripe.com/api/subscription_schedules/object) (incremental read supported)
-* [subscriptions](https://docs.stripe.com/api/subscriptions/object) (incremental read supported)
-* [tax/registrations](https://docs.stripe.com/api/tax/registrations/object)
-* [tax_ids](https://docs.stripe.com/api/tax_ids/object)
-* [tax_rates](https://docs.stripe.com/api/tax_rates/object) (incremental read supported)
-* [terminal/configurations](https://docs.stripe.com/api/terminal/configuration/object)
-* [terminal/locations](https://docs.stripe.com/api/terminal/locations/object)
-* [terminal/readers](https://docs.stripe.com/api/terminal/readers/object)
-* [test_helpers/test_clocks](https://docs.stripe.com/api/test_clocks/object)
-* [topups](https://docs.stripe.com/api/topups/object) (incremental read supported)
-* [transfers](https://docs.stripe.com/api/transfers/object) (incremental read supported)
-* [treasury/financial_accounts](https://docs.stripe.com/api/treasury/financial_accounts/object) (incremental read supported)
-* [webhook_endpoints](https://docs.stripe.com/api/webhook_endpoints/object)
-
-The Stripe connector supports only read actions on the following objects:
-* [application_fees](https://docs.stripe.com/api/application_fees/object) (incremental read supported)
-* [balance_transactions](https://docs.stripe.com/api/balance_transactions/object) (incremental read supported)
-* [climate/products](https://docs.stripe.com/api/climate/product/object)
-* [climate/suppliers](https://docs.stripe.com/api/climate/supplier/object)
-* [country_specs](https://docs.stripe.com/api/country_specs/object)
-* [events](https://docs.stripe.com/api/events/object) (incremental read supported)
-* [financial_connections/accounts](https://docs.stripe.com/api/financial_connections/accounts/object)
-* balance/history (Transaction history for balance changes) (incremental read supported)
-* [identity/verification_reports](https://docs.stripe.com/api/identity/verification_reports/object) (incremental read supported)
-* [invoice_rendering_templates](https://docs.stripe.com/api/invoice-rendering-template/object)
-* [issuing/physical_bundles](https://docs.stripe.com/api/issuing/physical_bundles/object)
-* [radar/early_fraud_warnings](https://docs.stripe.com/api/radar/early_fraud_warnings/object) (incremental read supported)
-* [reporting/report_types](https://docs.stripe.com/api/reporting/report_type/object)
-* [reviews](https://docs.stripe.com/api/radar/reviews/object) (incremental read supported)
-* [sigma/scheduled_query_runs](https://docs.stripe.com/api/sigma/scheduled_queries/object)
-* [tax_codes](https://docs.stripe.com/api/tax_codes/object)
-
-The Stripe connector supports only write actions on the following objects:
-* [account_links](https://docs.stripe.com/api/account_links/object)
-* [account_sessions](https://docs.stripe.com/api/account_sessions/object)
-* [apps/secrets](https://docs.stripe.com/api/apps/secret_store/secret_resource)
-* [billing/meter_event_adjustments](https://docs.stripe.com/api/billing/meter-event-adjustment/object)
-* [billing/meter_events](https://docs.stripe.com/api/billing/meter-event/object)
-* [billing_portal/sessions](https://docs.stripe.com/api/customer_portal/sessions/object)
-* [customer_sessions](https://docs.stripe.com/api/customer_sessions/object)
-* ephemeral_keys (Creates a short-lived API key for a given resource)
-* [financial_connections/sessions](https://docs.stripe.com/api/financial_connections/sessions/object)
-* [invoices/create_preview](https://docs.stripe.com/api/invoices/create_preview)
-* issuing/settlements (Updates the specified Issuing Settlement object)
-* [issuing/tokens](https://docs.stripe.com/api/issuing/tokens/object)
-* [issuing/tokens](https://docs.stripe.com/api/issuing/tokens/object)
-* [radar/value_list_items](https://docs.stripe.com/api/radar/value_list_items/object)
-* [sources](https://docs.stripe.com/api/sources/object)
-* [subscription_items](https://docs.stripe.com/api/subscription_items/object)
-* [tax/calculations](https://docs.stripe.com/api/tax/calculations/object)
-* [tax/settings](https://docs.stripe.com/api/tax/settings/object)
-* [terminal/connection_tokens](https://docs.stripe.com/api/terminal/connection_tokens/object)
-* [test_helpers/confirmation_tokens](https://docs.stripe.com/api/confirmation_tokens/object)
-* [test_helpers/issuing/authorizations](https://docs.stripe.com/api/issuing/authorizations/test_mode_create)
-* test_helpers/issuing/settlements (Create an Issuing settlement)
-* [test_helpers/treasury/outbound_payments](https://docs.stripe.com/api/treasury/outbound_payments/test_mode_update)
-* [test_helpers/treasury/outbound_transfers](https://docs.stripe.com/api/treasury/outbound_transfers/test_mode_update)
-* [test_helpers/treasury/received_credits](https://docs.stripe.com/api/treasury/received_credits/object)
-* [test_helpers/treasury/received_debits](https://docs.stripe.com/api/treasury/received_debits/object)
-* [treasury/credit_reversals](https://docs.stripe.com/api/treasury/credit_reversals/object)
-* [treasury/debit_reversals](https://docs.stripe.com/api/treasury/debit_reversals/object)
-* [treasury/inbound_transfers](https://docs.stripe.com/api/treasury/inbound_transfers/object)
-* [treasury/outbound_payments](https://docs.stripe.com/api/treasury/outbound_payments/object)
-* [treasury/outbound_transfers](https://docs.stripe.com/api/treasury/outbound_transfers/object)
+> Note: In theory, nested fields can be used with all Stripe objects.
+However, the objects marked as supporting nested fields in the tables also enable automatic expansion of related data
+via Stripe's [expand feature](https://docs.stripe.com/api/expanding_objects). For those objects,
+the connector can fetch extra fields that are not returned by default, and surface them. Field example for object `balance_transactions`: `"$['source']['payment_intent']['currency']"`.
+
+The Stripe connector supports reading and writing to and from the following objects:
+
+export const rows = [
+ {
+ label: "accounts", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/accounts/object"
+ }, {
+ label: "charges", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/charges/object"
+ }, {
+ label: "checkout/sessions", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/checkout/sessions/object"
+ }, {
+ label: "coupons", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/coupons/object"
+ }, {
+ label: "credit_notes", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/credit_notes/object"
+ }, {
+ label: "customers", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/customers/object"
+ }, {
+ label: "disputes", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/disputes/object"
+ }, {
+ label: "file_links", read: true, write: true, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/file_links/object"
+ }, {
+ label: "files", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/files/object"
+ }, {
+ label: "forwarding/requests", read: true, write: true, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/forwarding/request/object"
+ }, {
+ label: "identity/verification_sessions", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/identity/verification_sessions/object"
+ }, {
+ label: "invoiceitems", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/invoiceitems/object"
+ }, {
+ label: "invoices", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/invoices/object"
+ }, {
+ label: "issuing/authorizations", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/issuing/authorizations/object"
+ }, {
+ label: "issuing/cardholders", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/issuing/cardholders/object"
+ }, {
+ label: "issuing/cards", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/issuing/cards/object"
+ }, {
+ label: "issuing/disputes", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/issuing/disputes/object"
+ }, {
+ label: "issuing/transactions", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/issuing/transactions/object"
+ }, {
+ label: "payment_intents", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/payment_intents/object"
+ }, {
+ label: "payouts", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/payouts/object"
+ }, {
+ label: "plans", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/plans/object"
+ }, {
+ label: "prices", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/prices/object"
+ }, {
+ label: "products", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/products/object"
+ }, {
+ label: "promotion_codes", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/promotion_codes/object"
+ }, {
+ label: "radar/value_lists", read: true, write: true, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/radar/value_lists/object"
+ }, {
+ label: "refunds", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/refunds/object"
+ }, {
+ label: "reporting/report_runs", read: true, write: true, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/reporting/report_run/object"
+ }, {
+ label: "setup_intents", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/setup_intents/object"
+ }, {
+ label: "shipping_rates", read: true, write: true, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/shipping_rates/object"
+ }, {
+ label: "subscription_schedules", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/subscription_schedules/object"
+ }, {
+ label: "subscriptions", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/subscriptions/object"
+ }, {
+ label: "tax_rates", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/tax_rates/object"
+ }, {
+ label: "topups", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/topups/object"
+ }, {
+ label: "transfers", read: true, write: true, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/transfers/object"
+ }, {
+ label: "billing/alerts", read: true, write: true, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/billing/alert/object"
+ }, {
+ label: "billing/credit_grants", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/billing/credit-grant/object"
+ }, {
+ label: "billing/meters", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/billing/meter/object"
+ }, {
+ label: "billing_portal/configurations", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/customer_portal/configurations/object"
+ }, {
+ label: "climate/orders", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/climate/order/object"
+ }, {
+ label: "entitlements/features", read: true, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/entitlements/feature/object"
+ }, {
+ label: "issuing/personalization_designs", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/issuing/personalization_designs/object"
+ }, {
+ label: "payment_links", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/payment-link/object"
+ }, {
+ label: "payment_method_configurations", read: true, write: true, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/payment_method_configurations/object"
+ }, {
+ label: "payment_method_domains", read: true, write: true, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/payment_method_domains/object"
+ }, {
+ label: "payment_methods", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/payment_methods/object"
+ }, {
+ label: "quotes", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/quotes/object"
+ }, {
+ label: "tax/registrations", read: true, write: true, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/tax/registrations/object"
+ }, {
+ label: "tax_ids", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/tax_ids/object"
+ }, {
+ label: "terminal/configurations", read: true, write: true, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/terminal/configuration/object"
+ }, {
+ label: "terminal/locations", read: true, write: true, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/terminal/locations/object"
+ }, {
+ label: "terminal/readers", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/terminal/readers/object"
+ }, {
+ label: "test_helpers/test_clocks", read: true, write: true, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/test_clocks/object"
+ }, {
+ label: "webhook_endpoints", read: true, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/webhook_endpoints/object"
+ }, {
+ label: "apple_pay/domains", read: true, write: true, incr: false, nested: false, subscribe: false,
+ display: "Apple Pay Domains"
+ }, {
+ label: "application_fees", read: true, write: false, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/application_fees/object"
+ }, {
+ label: "balance_transactions", read: true, write: false, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/balance_transactions/object"
+ }, {
+ label: "events", read: true, write: false, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/events/object"
+ }, {
+ label: "identity/verification_reports", read: true, write: false, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/identity/verification_reports/object"
+ }, {
+ label: "radar/early_fraud_warnings", read: true, write: false, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/radar/early_fraud_warnings/object"
+ }, {
+ label: "reviews", read: true, write: false, incr: true, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/radar/reviews/object"
+ }, {
+ label: "balance/history", read: true, write: false, incr: true, nested: true, subscribe: false,
+ display: "Transaction history for balance changes"
+ }, {
+ label: "climate/products", read: true, write: false, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/climate/product/object"
+ }, {
+ label: "climate/suppliers", read: true, write: false, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/climate/supplier/object"
+ }, {
+ label: "billing/credit_balance_transactions", read: true, write: false, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/billing/credit-balance-transaction/object"
+ }, {
+ label: "invoice_payments", read: true, write: false, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/invoice-payment/object"
+ }, {
+ label: "country_specs", read: true, write: false, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/country_specs/object"
+ }, {
+ label: "financial_connections/accounts", read: true, write: false, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/financial_connections/accounts/object"
+ }, {
+ label: "invoice_rendering_templates", read: true, write: false, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/invoice-rendering-template/object"
+ }, {
+ label: "issuing/physical_bundles", read: true, write: false, incr: false, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/issuing/physical_bundles/object"
+ }, {
+ label: "reporting/report_types", read: true, write: false, incr: false, nested: false, subscribe: true,
+ href: "https://docs.stripe.com/api/reporting/report_type/object"
+ }, {
+ label: "sigma/scheduled_query_runs", read: true, write: false, incr: false, nested: true, subscribe: true,
+ href: "https://docs.stripe.com/api/sigma/scheduled_queries/object"
+ }, {
+ label: "tax_codes", read: true, write: false, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/tax_codes/object"
+ }, {
+ label: "account_links", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/account_links/object"
+ }, {
+ label: "account_sessions", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/account_sessions/object"
+ }, {
+ label: "apps/secrets", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/apps/secret_store/secret_resource"
+ }, {
+ label: "billing/meter_event_adjustments", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/billing/meter-event-adjustment/object"
+ }, {
+ label: "billing/meter_events", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/billing/meter-event/object"
+ }, {
+ label: "billing_portal/sessions", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/customer_portal/sessions/object"
+ }, {
+ label: "customer_sessions", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/customer_sessions/object"
+ }, {
+ label: "financial_connections/sessions", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/financial_connections/sessions/object"
+ }, {
+ label: "invoices/create_preview", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/invoices/create_preview"
+ }, {
+ label: "issuing/tokens", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/issuing/tokens/object"
+ }, {
+ label: "radar/value_list_items", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/radar/value_list_items/object"
+ }, {
+ label: "sources", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/sources/object"
+ }, {
+ label: "subscription_items", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/subscription_items/object"
+ }, {
+ label: "tax/calculations", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/tax/calculations/object"
+ }, {
+ label: "tax/settings", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/tax/settings/object"
+ }, {
+ label: "terminal/connection_tokens", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/terminal/connection_tokens/object"
+ }, {
+ label: "test_helpers/confirmation_tokens", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/confirmation_tokens/object"
+ }, {
+ label: "test_helpers/issuing/authorizations", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/issuing/authorizations/test_mode_create"
+ }, {
+ label: "issuing/settlements", read: false, write: true, incr: false, nested: false, subscribe: false,
+ display: "Updates the specified Issuing Settlement object"
+ }, {
+ label: "test_helpers/issuing/settlements", read: false, write: true, incr: false, nested: false, subscribe: false,
+ display: "Create an Issuing settlement"
+ }, {
+ label: "ephemeral_keys", read: false, write: true, incr: false, nested: false, subscribe: false,
+ display: "Creates a short-lived API key for a given resource"
+ },
+]
+
+export const Check = () => ✅
+export const Cross = () => 🚫
+export const NA = () => N/A
+export const Incremental = () => ✅ incremental
+
+export function renderCellValue(value) {
+ if (value === null) {
+ return | + Object + | ++ Bot connector + | ++ User connector + | +||||
|---|---|---|---|---|---|---|
| Read | +Write | +Subscribe | + +Read | +Write | +Subscribe | +|
| + + {row.label} + + | + +{renderCellValue(row.bot.read)} | +{renderCellValue(row.bot.write)} | +{renderCellValue(row.bot.subscribe)} | + ++ {renderCellValue(row.user.read)} + | +{renderCellValue(row.user.write)} | +{renderCellValue(row.user.subscribe)} | +
+
+
+
+
+
+#### Treasury API
+
+The Stripe connector supports reading and writing to and from the following Treasury API objects:
+
+export const treasuryApiRows = [
+ {
+ label: "treasury/financial_accounts", read: true, write: true, incr: true, nested: true, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/financial_accounts/object"
+ }, {
+ label: "treasury/credit_reversals", read: true, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/credit_reversals/object"
+ }, {
+ label: "treasury/debit_reversals", read: true, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/debit_reversals/object"
+ }, {
+ label: "treasury/inbound_transfers", read: true, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/inbound_transfers/object"
+ }, {
+ label: "treasury/outbound_payments", read: true, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/outbound_payments/object"
+ }, {
+ label: "treasury/outbound_transfers", read: true, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/outbound_transfers/object"
+ }, {
+ label: "treasury/received_credits", read: true, write: null, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/received_credits/object"
+ }, {
+ label: "treasury/received_debits", read: true, write: null, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/received_debits/object"
+ }, {
+ label: "treasury/transaction_entries", read: true, write: null, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/transaction_entries/object"
+ }, {
+ label: "treasury/transactions", read: true, write: null, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/transactions/object"
+ }, {
+ label: "test_helpers/treasury/outbound_payments", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/outbound_payments/test_mode_update"
+ }, {
+ label: "test_helpers/treasury/outbound_transfers", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/outbound_transfers/test_mode_update"
+ }, {
+ label: "test_helpers/treasury/received_credits", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/received_credits/test_mode_create"
+ }, {
+ label: "test_helpers/treasury/received_debits", read: false, write: true, incr: false, nested: false, subscribe: false,
+ href: "https://docs.stripe.com/api/treasury/received_debits/test_mode_create"
+ },
+]
+
+| Object | +Read | +Write | +Nested Field | +Subscribe | +
|---|---|---|---|---|
|
+ {row.href ? {row.label} : row.label}
+ {row.display ? {row.display} : null}
+ |
+ {row.incr ? |
+ {renderCellValue(row.write)} | +{row.nested ? |
+ {renderCellValue(row.subscribe)} | +
+
+
+
+
### Example integration
diff --git a/src/provider-guides/surveyMonkey.mdx b/src/provider-guides/surveyMonkey.mdx
index f416e3df..be40cc7c 100644
--- a/src/provider-guides/surveyMonkey.mdx
+++ b/src/provider-guides/surveyMonkey.mdx
@@ -1,30 +1,84 @@
---
-title: "Survey Monkey"
+title: "SurveyMonkey"
+description: "Connect SurveyMonkey to Ampersand using OAuth, then use read, write, and proxy actions across surveys, contacts, contact lists, groups, and response counts."
---
-## What's Supported
-### Supported Actions
+## What's supported
-This connector supports:
-- [Proxy Actions](/proxy-actions), using the base URL `https://api.surveymonkey.com`.
+### Supported actions
-## Before You Get Started
+This connector supports:
-To connect SurveyMonkey with Ampersand, you need to [Create a SurveyMonkey Account](#create-a-surveymonkey-account) and obtain the following credentials from your SurveyMonkey App:
+- [Read Actions](/read-actions), including full historic backfill.
+- [Write Actions](/write-actions) (create, update, and delete — depending on the object).
+- [Proxy Actions](/proxy-actions), using the base URL `https://api.surveymonkey.com`.
+- Subscribe Actions are not currently supported.
+
+### Supported objects
+
+export const Check = () => ✅
+export const Cross = () => 🚫
+
+| Object | +Read | +Write | +Nested Field | +Subscribe | +
|---|---|---|---|---|
|
+ {row.href ? {row.label} : row.label}
+ {row.display ? {row.display} : null}
+ |
+ {row.incr ? |
+ {renderCellValue(row.write)} | +{row.nested ? |
+ {renderCellValue(row.subscribe)} | +
+
+
+
+
+
+### Notes and limitations
+
+- **Write support**
+ - `contacts`, `contact_lists`, `surveys`: create, update, and delete
+ - `survey_folders`: create only
+ - `contact_fields`: update only (label)
+- **Not available as objects:** survey responses, collectors, survey pages, survey questions, and webhooks. Use [Proxy Actions](/proxy-actions) if you need access to other SurveyMonkey API endpoints.
+
+### Example integration
+
+For an example manifest file of a SurveyMonkey integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/surveyMonkey/amp.yaml).
+
+## Before you get started
+
+To connect SurveyMonkey with Ampersand, you need to [create a SurveyMonkey account](#create-a-surveymonkey-account) and obtain the following credentials from your SurveyMonkey app:
- Client ID
- Client Secret
-You will then use these credentials to connect your application to Ampersand.
+You will use these credentials to connect your application to Ampersand.
-### Create a SurveyMonkey Account
+### Create a SurveyMonkey account
You need a **SurveyMonkey** account to connect with Ampersand. If you do not have a SurveyMonkey account, here's how you can sign up:
-- Go to the [SurveyMonkey site](https://www.surveymonkey.com/).
+- Go to the [SurveyMonkey site](https://www.surveymonkey.com/).
- Sign up for a free account using your preferred method.
-### Creating a SurveyMonkey App
+### Creating a SurveyMonkey app
1. Log in to the [SurveyMonkey Developer Portal](https://developer.surveymonkey.com/).
@@ -32,8 +86,8 @@ You need a **SurveyMonkey** account to connect with Ampersand. If you do not hav
3. On the _Create a New App_ form, enter the following details:
1. **App Name**: The name of the app.
- 2. **App Creator**: Email address of the app owner.
- 3. **Select an app type.**: Specify whether the application should be private or public.
+ 2. **App Creator**: Email address of the app owner.
+ 3. **Select an app type**: Specify whether the application should be private or public.
4. Click **Create App**.
@@ -47,7 +101,9 @@ You need a **SurveyMonkey** account to connect with Ampersand. If you do not hav
7. Click **Submit changes**.
-8. From the **Scopes** section, select the scopes required for your application.
+8. From the **Scopes** section, select the scopes required for your application. Common scopes include:
+ - **View Surveys** / **Create/Modify Surveys** — for reading and writing surveys
+ - **View Contacts** / **Create/Modify Contacts** — for reading and writing contacts and contact lists
9. Click **Update Scopes**.
@@ -57,20 +113,39 @@ You need a **SurveyMonkey** account to connect with Ampersand. If you do not hav
You can find the **Client ID** and **Client Secret** keys on the **Overview** page of your application. Note these keys, as they are essential for connecting your app to Ampersand.
-## Add SurveyMonkey App Details in Ampersand
+Some scopes require a paid SurveyMonkey plan or additional approval for public apps. Configure only the scopes your integration uses.
+
+## Add your SurveyMonkey app info to Ampersand
1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).
-2. Select the project where you want to add the SurveyMonkey App.
+2. Select the project where you want to add the SurveyMonkey app.
3. Navigate to the **Provider Apps** section.
-4. Select **SurveyMonkey** from the Provider list.
+4. Select **SurveyMonkey** from the **Provider** list.
5. Enter the previously obtained **Client ID** in the **Client ID** field and the **Client Secret** in the **Client Secret** field.
- 
+ 
6. Click **Save Changes**.
+
+## Using the connector
+
+To start integrating with SurveyMonkey:
+
+- Create a manifest file like the [example](https://github.com/amp-labs/samples/blob/main/surveyMonkey/amp.yaml).
+- Deploy it using the [amp CLI](/cli/overview).
+- If using Read or Write actions: create a [destination](/destinations).
+- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for OAuth authorization.
+- Start using the connector!
+ - If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
+ - If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
+ - If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.
+
+## API documentation
+
+- [SurveyMonkey API v3](https://api.surveymonkey.com/v3/docs)
diff --git a/src/provider-guides/zoho.mdx b/src/provider-guides/zoho.mdx
index 4c89da3d..9074acb5 100644
--- a/src/provider-guides/zoho.mdx
+++ b/src/provider-guides/zoho.mdx
@@ -1,5 +1,6 @@
---
title: "Zoho"
+description: "Connect Zoho CRM, Zoho Desk, and Zoho Mail to Ampersand using OAuth, and set up read, write, and subscribe actions across the supported objects."
---
The Zoho connector supports the following Zoho products:
diff --git a/src/provider-guides/zoominfo.mdx b/src/provider-guides/zoominfo.mdx
index 827b923f..04201759 100644
--- a/src/provider-guides/zoominfo.mdx
+++ b/src/provider-guides/zoominfo.mdx
@@ -1,5 +1,6 @@
---
-title: ZoomInfo
+title: "ZoomInfo"
+description: "Connect ZoomInfo to Ampersand using OAuth 2.0. Register a Developer Portal app, configure the redirect URI, and use proxy actions to call the API."
---
## What's supported
diff --git a/src/read-actions.mdx b/src/read-actions.mdx
index 41574d84..7812ee60 100644
--- a/src/read-actions.mdx
+++ b/src/read-actions.mdx
@@ -1,5 +1,6 @@
---
title: "Read actions"
+description: "Define read actions in amp.yaml to schedule or trigger reads of standard and custom objects from a customer's SaaS, with backfill, filters, and mapping."
---
A read action reads data from your customer's SaaS and send them to Destinations that you define.
@@ -202,6 +203,34 @@ If you want different filter behavior for backfill vs. incremental reads, you ca
In this example, the backfill will only return contacts whose `firstname` equals "Brian", while subsequent incremental reads will only return contacts whose `status` equals "active".
+### Filter field names
+
+The `fieldName` of a filter must be the field's name in the provider's API, and it is case-sensitive.
+
+| Object | +Metadata | +Read | +Write | +Subscribe | +
|---|---|---|---|---|
| benchmark_bundles | ||||
| contact_fields | ||||
| contact_lists | ||||
| contacts | ||||
| groups | ||||
| organizations | ||||
| question_bank_questions | ||||
| roles | ||||
| survey_categories | ||||
| survey_folders | ||||
| survey_languages | ||||
| survey_templates | ||||
| surveys | ||||
| team_survey_templates | ||||
| workgroups |
-2. Ensure that the checkboxes for the necessary [system permissions](/customer-guides/salesforce#system-permissions-needed) are selected, and then click **Save**.
+2. Ensure that the checkboxes for the necessary [system permissions](/customer-guides/salesforce#required-system-permissions) are selected, and then click **Save**.
diff --git a/src/subscribe-actions.mdx b/src/subscribe-actions.mdx
index e72fded6..dd545064 100644
--- a/src/subscribe-actions.mdx
+++ b/src/subscribe-actions.mdx
@@ -1,5 +1,6 @@
---
title: "Subscribe actions"
+description: "Receive near-instant webhooks from customer SaaS apps with Ampersand subscribe actions on create, update, delete, and association change events."
---
With subscribe actions, you'll receive near-instant webhooks as events occur in your customers' SaaS applications. This enables your application to quickly react to events such as record creation, deletion, and field updates.
@@ -78,12 +79,6 @@ integrations:
For an example of a webhook message delivered according to the above `amp.yaml`, please see [Subscribe action webhooks](/destinations/webhooks#subscribe-action-webhooks).
-### Quota optimization
-
-Quota optimization reduces API quota consumption for Subscribe update events by filtering irrelevant change events at the source, so only updates that affect watched fields are delivered. It is opt-in and is not enabled by default.
-
-Currently supported for Salesforce. See [Quota optimization for Subscribe Actions](/provider-guides/salesforce#quota-optimization-for-subscribe-actions) in the Salesforce provider guide for more information.
-
### Association changes
In HubSpot, association changes do not trigger update events, you must subscribe to them specifically using `associationChangeEvent`. On the other hand, in Salesforce, you can subscribe to fields that refer to associations (e.g. You can subscribe to update events on the `accountid` field of contacts).
diff --git a/src/troubleshooting-guides/salesforce.mdx b/src/troubleshooting-guides/salesforce.mdx
index 9e616f40..88335f27 100644
--- a/src/troubleshooting-guides/salesforce.mdx
+++ b/src/troubleshooting-guides/salesforce.mdx
@@ -25,7 +25,7 @@ for the appropriate names.
### Resolve a field-level visibility issue
-Share the [field visibility instructions in the Salesforce customer guide](/customer-guides/salesforce#ensure-sufficient-permissions) with your customer. That user must be granted **Visible** field-level visibility for the field, either through their profile or via a permission set.
+Share the [field visibility instructions in the Salesforce customer guide](/customer-guides/salesforce#choose-credentials-and-grant-access) with your customer. That user must be granted **Visible** field-level visibility for the field, either through their profile or via a permission set.
Ampersand pauses reads automatically after repeated failures to avoid overloading Salesforce APIs, so once the field is visible you'll need to explicitly resume. Call the [Unpause Reads endpoint](/reference/read/unpause-reads-for-an-installation), or reach out to Ampersand support and we can unpause it for you.
diff --git a/src/write-actions.mdx b/src/write-actions.mdx
index abda51f6..142d7dd9 100644
--- a/src/write-actions.mdx
+++ b/src/write-actions.mdx
@@ -1,5 +1,6 @@
---
title: "Write actions"
+description: "Define write actions in amp.yaml so your app can create or update records in your customer's SaaS via Ampersand's Write API, including shared field mappings."
---
A write action writes data to your customer's SaaS whenever you make an API request to us. This page focuses on writing data to existing fields. If you are looking to create new custom fields prior to writing data, please see [Create or update custom fields](/manage-customer-schemas#create-or-update-custom-fields).
@@ -23,7 +24,7 @@ integrations:
### Share mappings with read actions
-If you are using Read Actions and have already defined [field mappings](/read-actions#field-mappings), your Write Actions can automatically use the same mappings if you add `inheritMapping` to your manifest file. When you call our Write API, we will ensure that we are writing back to the appropriate field that the customer has mapped.
+If you are using Read Actions and have already defined [field mappings](/read-actions#object-and-field-mappings), your Write Actions can automatically use the same mappings if you add `inheritMapping` to your manifest file. When you call our Write API, we will ensure that we are writing back to the appropriate field that the customer has mapped.
```YAML
specVersion: 1.0.0