Skip to main content

OnRamp Widget

Embed OnRamp into your app!

Melissa Scatena avatar
Written by Melissa Scatena
Updated over a year ago

OnRamp offers a customizable widget that can be embedded on your website in a few simple steps by your development team. The widget is displayed at the bottom center of your app, and can be easily customized.

Settings - OnRamp 2022-12-12 at 2.14.52 PM

How does it work?

When enabled, if your customer users are both shared on an active OnRamp project and logged into your platform, the widget will appear for them in your application, making it easy for them to access the project.

The widget will show their logo as well as key information about the project. It will allow the user to open their OnRamp project (in a new tab) to see status and complete tasks.

If a user of your platform is not being actively shared on an OnRamp project, or a project has been marked Completed or Archived, the widget will not appear.

How to setup and customize the Widget

Access the Widget in Settings

Profile - OnRamp 2022-12-12 at 2.18.47 PM

To set up the Widget, click on 'Script'. This is the Javascript that your development team will use to embed the Widget into your platform.

Profile - OnRamp 2022-12-12 at 2.22.06 PM
  1. Ask your development team to:

    1. Embed the snippet on every page you want the embed to display - this could be all pages of your app or just your user's Home page, for example

      1. Our recommendation it to insert the snippet in the Head or immediately after the Body tag, however every site architecture is different

    2. Pass the email of currently logged in user to the widget in the email field (either as text or Base64 encoded)

  2. That's it!

How to Customize the Widget

You can customize the widget yourself! No need for IT resources. You can also choose to unpin the widget and remind the user intermittently when it is unpinned.

Roles - OnRamp 2022-12-09 at 1.59.25 PM

Did this answer your question?