- Overview
- Notifications
- Troubleshooting
- Connector Builder
- ActiveCampaign
- Active Directory - Preview
- Adobe Acrobat Sign
- Adobe PDF Services
- Amazon Bedrock
- Amazon Connect
- Amazon Polly
- Amazon SES
- Amazon Transcribe
- Amazon Web Services
- Anthropic Claude
- Asana
- AWeber
- Azure AI Document Intelligence
- Azure Maps
- BambooHR
- Box
- Brevo
- Calendly
- Campaign Monitor
- Cisco Webex Teams
- Citrix ShareFile
- Clearbit
- Confluence Cloud
- Constant Contact
- Coupa
- Customer.io
- Datadog
- Deputy
- Discord
- DocuSign
- Drip
- Dropbox
- Egnyte
- Eventbrite
- Exchangerates
- Exchange Server - Preview
- Expensify
- Facebook
- Freshbooks
- Freshdesk
- Freshservice
- GetResponse
- GitHub
- Gmail
- Google Cloud Platform
- Google Docs
- Google Drive
- Google Maps
- Google Sheets
- Google Speech-to-Text
- Google Text-to-Speech
- Google Vertex
- Google Vision - Preview
- Google Workspace - Preview
- GoToWebinar
- Greenhouse
- HTTP Webhook - Preview
- Hubspot CRM
- HubSpot Marketing
- HyperV - Preview
- iContact
- Insightly CRM
- Intercom
- Jira
- Keap
- Klaviyo
- LinkedIn
- Mailchimp
- Mailgun
- Mailjet
- MailerLite
- Marketo
- Microsoft 365
- Microsoft Azure
- Microsoft Azure Active Directory
- Microsoft Azure OpenAI
- Microsoft Dynamics 365 CRM
- Microsoft OneDrive & Sharepoint
- Microsoft Outlook 365
- Microsoft Sentiment
- Microsoft Teams
- Microsoft Translator
- Microsoft Vision
- Miro
- Okta
- OpenAI
- Oracle Eloqua
- Oracle NetSuite
- PagerDuty
- PayPal
- PDFMonkey
- Pinecone
- Pipedrive
- QuickBooksOnline
- Quip
- Salesforce
- Salesforce Marketing Cloud
- SAP Concur
- SendGrid
- ServiceNow
- Shopify
- Slack
- SmartRecruiters
- Smartsheet
- Stripe
- Sugar Enterprise
- Sugar Professional
- Sugar Sell
- Sugar Serve
- System Center - Preview
- TangoCard
- Todoist
- Trello
- Twilio
- X (formerly Twitter)
- Xero
- watsonx.ai
- WhatsApp Business
- WooCommerce
- Workable
- Workday
- YouTube
- Zendesk
- Zoho Campaigns
- Zoho Desk
- Zoho Mail
- ZoomInfo
Building your connector from an API definition
-
If you select Start from an API definition, you must provide the API definition:
- From a local file – Upload a Postman or Swagger collection.
-
From a URL – Enter a file URL, such as
https://petstore.swagger.io/v2/swagger.json
.
- Click Continue.
-
In the Confirm import window, you can:
- Change the Provider name, Application name, and Connector name.
-
Modify the resources you want to use in your custom connector. All available resources are automatically enabled; disable the ones you wish to exclude.
-
Use the Search bar to look for a specific resource.
-
- Click Create.
- The Settings window is now displayed.
-
In the Info tab you can configure the following fields:
- Name - This is reflected in your connector key.
- API type – This field is disabled by default, as only REST is currently supported.
- Categories - You can select from the available categories, such as Artificial intelligence or Marketing, or create your on.
- Description – Enter a description for your connector.
- Icon – Click Browse to upload an image from your computer. All image types are supported, but we recommend using a square SVG.
- Catalog preview displays how your custom connector will appear in the Integration Service connector catalog.
-
Click Save.
In the Base API tab, you configure the base URL for the application API and pagination:
- Base URL – Automatically filled with the value declared at connector creation.
- Pagination type – Options available in the drop-down are: Page start with 1, Page starts with 0, Offset, Custom. If the vendor documentation doesn’t provide any details on pagination, keep the default value.
- Pagination max – Default value is
100
. If the vendor documentation doesn’t provide any details on pagination, keep the default value. - Content-Type header – This field is disabled by default, as only
application/json
is currently supported. -
Accept header – This field is disabled by default, as only
application/json
is currently supported.
In the Authentication tab, you configure the authentication type for your connector. See more information on the supported options in Authentication types.
Once you have completed the authentication configuration, select Add connection from the drop-down menu:
If your connection is successful, the status is updated to Connected.
Connector Builder generates the list of resources based on the provided API definition. The left-side menu displays the list of available resources, organized in groups.
- Click the More options button menu to further configure each method. You
can:
- Add method – Opens the Create new resource window.
- Allow method deletion – Activates a Delete icon for each resource in the group.
- Edit path – Edit the
resource’s path. For example:
[BASE URL]/pet = https://petstore.swagger.io/v2/pet
- Delete – Deletes a resource group. A message warns you that the operation cannot be undone.
- Duplicate – Opens the
Duplicate resource window, where you can edit the path, choose a
display name and select methods.
-
You can also Create new resource group in two ways:
- Blank: Configure the
following fields:
- Path -
[Base URL]/[path]
- Display name
- Select methods: Get, Get By Id, Post, Put, Patch, Delete
- Path -
- From cURL: enter a cURL command.
- Blank: Configure the
following fields:
Configure your resources
When you select a resource, the following window is displayed:
Depending on the resource method you select, the following configuration tabs are available: Parameters, Response/Request Fields, Pagination, Search.
Parameters
For example, all four tabs are available for GET methods. For POST methods, you can only see the Parameters, Request Fields, and Response Fields tabs.
In Parameters, you can view the list available parameters for the selected resource, add new parameters, or import parameters from an existing resource.
The parameters listed in this table are the ones you will use in Studio when building automations using your custom connector.
The Pet object corresponds to the Pet resource group, and the available fields are the ones set for the GETBYID resource:
Response and Request fields
Nested array objects are not currently supported.
In each respective tab, you can edit or delete any field. If you click the Edit icon, the following configuration window is displayed:
In the Response/Request fields tab, the following options are also available:
- Overwrite on send request checkbox - If selected, when you execute a Send request, the fields list is regenerated. Do not select this option if you added new fields to your resource.
-
Additional options button:
Option
What it does
Update response root key
Define the response key when dealing with nested arrays in the response.
Delete all fields for method
Deletes all fields for the selected method.
Generate from payload
Use a sample payload from the service documentation or an API call to generate the resource fields.
- Add row button - Adds new fields to the resource.
Click the Visible columns icon to add or delete columns in the fields table.
Each color under the Methods column corresponds to a certain method: Get, Get by ID, Post, Put, Patch, Delete.
Pagination
Enable Pagination for a resource if you expect a list response. If you enable pagination, you also need to define the Response root key in the configuration tab, for nested lists.
Search
Activate the Enable Search checkbox to allow search setup for a resource.
After you configure everything you need, you can continue with .