Getting Started

A brief overview of what apps are on Pitchly, and how to create them.

At the core of Pitchly is an organization with any number of potential databases. But also one of the powers of Pitchly is the ability to seamlessly connect data from those databases to Apps. You can think of Apps as outputs from data, whereas Integrations are inputs.

The process to create an app on Pitchly is actually pretty straightforward. There are three main steps:

  1. Register your app on Pitchly

  2. Generate an access token over our REST API

  3. Get resources, like data, from the user's account over our GraphQL API

Some of these steps, like step #2, you probably don't even need to worry about if you are building a web app inside Pitchly, because we handle access token generation and renewal for you via our JavaScript SDK. The rest, we will try to make as simple as possible.

The different kinds of apps

There are conceptually three different kinds of apps you can build in Pitchly, depending on where you want your app to live. The three are:

  1. Inside Apps

  2. Outside Apps (coming soon)

  3. Hybrid Apps (coming soon)

Inside apps "live" inside the Pitchly platform and are shown to the user via an iframe, side by side with their database, but your app is hosted elsewhere.

Outside apps live primarily on your own website or web page but connect with users' Pitchly accounts via a Pitchly Connect button.

Hybrid apps are simply a combination of both strategies, which gives you the ability to both enhance your existing app with Pitchly support and have your app available at a moment's notice to users working inside their Pitchly database.

Registering your app

To create an app on Pitchly, you must first register your app with the Pitchly platform, so we know things like your app's name and where to look for your app. This will also generate a unique App ID, which you can then use to communicate with Pitchly's APIs.

Our API is currently in beta, so we don't allow public registrations today. If you would like to register your app with Pitchly, please contact us at developers@pitchly.net.

Read on to learn how to generate access tokens using Pitchly's JavaScript SDK.