Skip to main content
Version: 7.1.0

What is Connector Name?

Q: What is the connector name when creating a new connector?​

A: The connector name refers to the specific identifier chosen for the connector being created.
This name must be unique and can only consist of alphanumeric characters, hyphens, and dots. It should clearly describe the purpose of the connector.
For instance, a connector designed for Google Calendar could be named "google-calendar" or "googlecalendar".
The chosen name should be straightforward and indicative of its intended function.

Key Points about the Connector Name:​

  • The connector name must be unique and cannot be modified once created.
  • It supports only alphanumeric characters, hyphens, and dots.
  • The connector name is utilized in REST API path parameters.

Example of Connector Name in REST API Path Parameters:​

Consider you have created a connector named google-calendar.

When obtaining the OAuth URL for this connector, the URL structure would be:

GET http://{{server}}:{{port}}/v1/connector/google-calendar/oauth?userId={{userId}}

Example curl command:

curl --location 'http://{{server}}:{{port}}/v1/connector/google-calendar/oauth?userId={{userId}}' \
--header 'api_key: default'