Sign in
Connectors (Integrations)

Create a connector

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.

post/v3/connectors

Request body

OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "provider": "google",
  "settings": {
    "client_id": "abc-def",
    "client_secret": "xyz-abc-def",
    "topic_name": "topic-123"
  },
  "scope": [
    "https://www.googleapis.com/auth/userinfo.email",
    "https://www.googleapis.com/auth/userinfo.profile",
    "https://www.googleapis.com/auth/gmail.readonly"
  ]
}

Response

Connector Created

request_idstring

ID of the request.

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": {
    "name": "Google Connector",
    "provider": "google",
    "settings": {
      "topic_name": "abc123"
    },
    "scope": [
      "https://www.googleapis.com/auth/userinfo.email",
      "https://www.googleapis.com/auth/userinfo.profile"
    ],
    "active_credential_id": "c123f8e1a-eb1c-41c0-b6a6-d2e59daf7f47"
  }
}

Changes