Terminology

Integration Provider

An integration provider is a third party app that your end users connect to, such as Hubspot or Salesforce.

Schema

A schema represents a certain data resource with which you want to work. For example, if your company is in sales or marketing, you might want a schema for CRM contact data and a schema for CRM company data.

Schemas define precisely what data format these resources will be in, both for pushing out and pulling in records.

Schemas are typically identified through their endgrate_type: a unique keyword such as crm-contact or crm-company that encapsulates a given resource class.

Session

A session represents the connection between your end user and an integration provider. For example, a session could be a certain user's connection to HubSpot, or another user's connection to Salesforce.

Transfer

A transfer is an action (push or pull) taken for a given session. For example, a transfer might be pulling in CRM contact data, or pushing out CRM company data.

Integration Flow

When working with Endgrate, the integration flow usually consists of the following steps:

1. Initiate a session with some schemas you want to work with.
2. Redirect your end user to Endgrate. Through Endgrate's UI, the end user chooses an integration provider and authenticates into that provider.
3. Trigger transfers to push, pull, and sync data between your product and your end user's selected integration provider.