Now that we know how to create a Connector and where to find it in the Console, it’s time to start setting it up. Begin by clicking on the ‘Releases’ button.
You will be taken to a view that lists all of the Connector’s releases, which can include ‘Deprecated’, ‘Live’ and ‘Draft’ versions of your Connector. For newly-created Connectors, there will be one draft already created.
You should therefore see something that looks like this:
The icons on the right mean the following:
 | Edit – This is where you can edit and customize your Connector by adding methods, scripts, rate limits and parameters. |
 | Clone as a New Draft – clones the version as a new draft version. IMPORTANT! You can only have one Draft version of your Connector at a time. If you create a new draft version of your Connector, the old draft will be deleted. |
 | Export – exports that version of the Connector as a JSON file onto your computer. |
 | Delete – deletes that version. Be careful with this, as deleted versions are not recoverable. |
 | Compare to Previous – allows you to view the version in JSON format so you can easily make comparisons in the code between different versions. |
To begin working on the Connector, click on “Edit”. You will be taken to the Connector Settings page. This is where you can start building your Connector by adding settings, authentication, methods, scripts, etc.
You should see something like this:
Let’s have a quick look at the different Connector level settings that are available here. We will go into each of these further in the lessons, but this is to give you an oversight of what each of the different tabs in your Connector’s settings mean.
The Settings Tab
The Settings tab contains your general Connector settings, such as:
- Comments – Use this space to write a brief summary on what was done on this release. This can be read in the Connector Releases page under Notes, so they should be informative and short.
- Icon – The Icon you uploaded when you first created the Connector. You can change the Connector icon here as needed.
- Save – The save button appears on many of the tabs, when it is present make sure to press it to save your changes. If it’s not available to any of the tabs, remember to always navigate back to the Settings page to save your progress.
- Paging – Enable Connector-level paging settings
At the bottom of the page, you can also see the Last Modified timestamp, showing when was the last time that the release that you’re working on was saved.
The Authentication Tab
This tab allows you to configure the authentication settings of your Connector.
The Rate Limits Tab
This tab allows you to set the rate-limits of your Connector. Rate limit refers to the frequency with which API calls will be accepted by an application.
The Methods Tab
This is where all of your Connector’s methods are stored and created. You are able to access each method to edit it from this tab. You can also organize your methods further by using categories and subcategories.
The Parameters Tab
This is where you can edit your Connector-level parameters. Please note that any parameters that you set here will be available to every method in the Connector, since they are created at ‘Connector-level’.
Parameters can also be set on Method level.
The Triggers Tab
This is where you organize your triggers. Triggers are used for dynamic lookups for methods.
The Script Tab
This is where you write and store functions which are available to every method.
Deprecations Tab and Release Notes Tab
These tabs are used to mark outdated functionality, and detailed notes on what has changed in this release, respectively.