Ramp

​

What’s supported

​

Supported actions

This connector supports:

• Read Actions, including full historic backfill. Incremental reading is supported for the objects marked in the table below, a full read of the Ramp instance will be done per scheduled read.
• Write Actions.
• Proxy Actions, using the base URL https://api.ramp.com.

​

Supported objects

The Ramp connector supports the following objects:

​

Example integration

For an example manifest file of a Ramp integration, visit our samples repo on GitHub.

​

Before you get started

To connect Ramp with Ampersand, you will need a Ramp account. Once your account is created, you’ll need to create an app in your Ramp portal, configure the app, and obtain the following credentials from your app:

• Client ID
• Client Secret
• Scopes

You will then use these credentials to connect your application to Ampersand.

​

Create a Ramp account

To create an account for your organization, you need to apply here Ramp Support. An active account is required to log into your portal.

​

Creating a Ramp app

Once your Ramp account is set up, you can follow the steps below to create a Ramp app:

1. Log in to your Ramp Portal.
2. Navigate to https://app.ramp.com/ramp-developer.
3. Click the New app.
4. Enter the following details to register your Oauth app:
   1. App Name: The name of your app.
5. Click the Create App.
6. Add Redirect URIs: https://api.withampersand.com/callbacks/v1/oauth
7. Select the scopes for your application. Ramp will authorize access to the selected scopes for your application. Make sure to select a scope for every object your integration reads from or writes to — for example, transactions:read for reading transactions, and bills:write for writing bills.

You will find the Client ID and Client Secret in the app details. Note these credentials, as you will need them to connect your app to Ampersand.

​

Add your Ramp app info to Ampersand

1. Log in to your Ampersand Dashboard.
2. Select the project where you want to create a Ramp integration.
3. Select Provider Apps.
4. Select Ramp 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 scopes set for your application in Ramp.

​

Using the connector

To start integrating with Ramp:

• 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 OAuth authorization.
• 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.