Step 6: Managing Your Connector

Connectors can run on a variety of frequencies:

  • None — which means that it will be run manually whenever you want to pull in data
  • Hourly
  • Daily
  • Weekly
  • Monthly
  • Custom — you can select how often you want to repeat per Hour, Day, Week, or Month

When you set a frequency, you will also have the ability to add a Run Mode. This can be set per run for a given connector. The Run Mode will determine if we should delete entities in the run, and if so, which ones.

Trigger via API

In addition to clicking “Run Now” in the UI or setting a schedule for running your Connector, you can trigger a new run for your Connector via API.

  1. Create an app in your Developer Account with write permission on the connectors endpoint.
  2. POST a request to /v2/accounts/me/connectors/[connectorId]/trigger. Note that the POST request body will be empty – triggering a new run via the /trigger endpoint will start a run exactly as clicking the “Run Now” button in the UI does. Once you trigger a new run, the Connector will fetch data by making an API GET request according to its settings!