Templates used: | |
Release checklists: |
Note: This step is required for launch. Only brand new integrations should need to complete all the steps listed here.
Every new integration added to Stitch has a corresponding report card object for the Connect API.
Step 1: Save a copy of the source form property template
- Locate the template for the type of source you’re adding:
- Database:
_templates/connect/database-source-form-property.md
- SaaS:
_templates/connect/saas-source-form-property.md
- Database:
- Save a copy into the correct folder:
- Database:
_developer-files/connect/api/objects/form-properties/sources/databases
- SaaS:
_developer-files/connect/api/objects/form-properties/sources/saas
The file name should follow this convention:
[integration-name]-object.md
.For example:
Close.io
would have a file namedcloseio-object.md
. - Database:
Step 2: Find/replace
-
In the copy of the template, do a case-sensitive find/replace on
INTEGRATION
, replacing it with the display name of the integration. The display name is how the provider spells/displays their name.For example: If the name of the integration is
Close.io
orGoogle CloudSQL MySQL
, you would find/replaceINTEGRATION
withClose.io
orGoogle CloudSQL MySQL
. -
Next, perform a case-sensitive find/replace on
integration
, replacing it with the key name of the integration. It cannot contain anything but alphanumerical characters and dashes (-
).For example: If the display name of the integration is
Close.io
orGoogle CloudSQL MySQL
, you would find/replaceintegration
withcloseio
andgoogle-cloudsql-mysql
.
Step 3: Fill out the template
Fill out the template, using the appropriate template reference as a guide:
Step 4: Refer to your release checklist
If you’re working on a release, refer to the release checklist you’re using to wrap up the remaining steps for launch:
Back to top
Last updated: 28 July 2021