Create a connector - Connectors Integrations - API Reference

POST

/v3/connectors

Create a connector in your Nylas application.

Connectors are how your Nylas application stores information it needs to connect to external services. Creating a connector is the first step in setting up authentication for your project. See Supported providers for more information.

NYLAS API KEY

Request body

provider*string

The provider type. For Google providers, set to google.

Example: "google"

settingsobject

GCP provider auth app credentials and settings.

scopearray<string>

Set the default scopes for each connector. These scopes are overridden by scopes set on the specific grant.

Example:

["https://www.googleapis.com/auth/userinfo.email","https://www.googleapis.com/auth/userinfo.profile","https://www.googleapis.com/auth/gmail.readonly"]

Responses

request_idstring

ID of the request.

Example: "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90"

dataobject

curl --request POST \ --url 'https://api.us.nylas.com/v3/connectors' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --data '{ "provider": "google", "settings": { "client_id": "<NYLAS_CLIENT_ID>", "client_secret": "<NYLAS_CLIENT_SECRET>", "topic_name": "<TOPIC_NAME>" }, "scope": [ "https://www.googleapis.com/auth/userinfo.email", "https://www.googleapis.com/auth/userinfo.profile" ] }'