Skip to main content

​
What’s supported

​
Supported actions

This connector supports:
  • Read Actions, including full historic backfill. Please note that incremental reading is only supported for accounts, acquisitions, subscriptions, items, plans, add_ons, measured_units, coupons, invoices, line_items, credit_payments, transactions, custom_field_definitions and shipping_methods. For all other objects, a full read of the Recurly instance will be done per scheduled read.
  • Write Actions.
  • Proxy Actions, using the base URL https://v3.recurly.com.

​
Supported objects

The Recurly connector supports reading from the following objects: The Recurly connector supports writing to the following objects:

​
Example integration

For an example manifest file of a Recurly integration, visit our samples repo on Github.

​
Before you get started

To integrate Recurly with Ampersand, you will need a Recurly API Key.

​
Creating a Recurly API key

  1. Log in to your Recurly account.
  2. Navigate to Integrations > API Credentials.
  3. Click Add Private API Key.
  4. Provide a name for your API key and select the appropriate permissions.
  5. Click Save to generate the key.
  6. Copy and securely store the API key.

​
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 Recurly:
  • Create a manifest file like the example above.
  • Deploy it using the amp CLI.
  • If you are using Read Actions, create a destination.
  • Embed the InstallIntegration UI component. The UI component will prompt the customer for their username and password. Enter the API key as the username and leave the password field blank.
  • Start using the connector!
    • If your integration has Read Actions, you’ll start getting webhook messages.
    • If your integration has Write Actions, you can start making API calls to our Write API.
    • If your integration has Proxy Actions, you can start making Proxy API calls.