Generate a new connection
curl --request POST \
--url https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"groupRef": "group-123",
"consumerRef": "<string>",
"provider": "<string>",
"providerWorkspaceRef": "<string>",
"providerMetadata": {},
"groupName": "<string>",
"consumerName": "<string>",
"apiKey": "<string>",
"customAuth": {
"serviceAccountKey": "base64encodedkey",
"scopes": [
"https://www.googleapis.com/auth/calendar",
"https://mail.google.com/"
]
},
"oauth2AuthorizationCode": {
"scopes": [
"<string>"
]
}
}
'import requests
url = "https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate"
payload = {
"groupRef": "group-123",
"consumerRef": "<string>",
"provider": "<string>",
"providerWorkspaceRef": "<string>",
"providerMetadata": {},
"groupName": "<string>",
"consumerName": "<string>",
"apiKey": "<string>",
"customAuth": {
"serviceAccountKey": "base64encodedkey",
"scopes": ["https://www.googleapis.com/auth/calendar", "https://mail.google.com/"]
},
"oauth2AuthorizationCode": { "scopes": ["<string>"] }
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groupRef: 'group-123',
consumerRef: '<string>',
provider: '<string>',
providerWorkspaceRef: '<string>',
providerMetadata: {},
groupName: '<string>',
consumerName: '<string>',
apiKey: '<string>',
customAuth: {
serviceAccountKey: 'base64encodedkey',
scopes: ['https://www.googleapis.com/auth/calendar', 'https://mail.google.com/']
},
oauth2AuthorizationCode: {scopes: ['<string>']}
})
};
fetch('https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'groupRef' => 'group-123',
'consumerRef' => '<string>',
'provider' => '<string>',
'providerWorkspaceRef' => '<string>',
'providerMetadata' => [
],
'groupName' => '<string>',
'consumerName' => '<string>',
'apiKey' => '<string>',
'customAuth' => [
'serviceAccountKey' => 'base64encodedkey',
'scopes' => [
'https://www.googleapis.com/auth/calendar',
'https://mail.google.com/'
]
],
'oauth2AuthorizationCode' => [
'scopes' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate"
payload := strings.NewReader("{\n \"groupRef\": \"group-123\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"consumerName\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"serviceAccountKey\": \"base64encodedkey\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/calendar\",\n \"https://mail.google.com/\"\n ]\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"groupRef\": \"group-123\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"consumerName\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"serviceAccountKey\": \"base64encodedkey\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/calendar\",\n \"https://mail.google.com/\"\n ]\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groupRef\": \"group-123\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"consumerName\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"serviceAccountKey\": \"base64encodedkey\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/calendar\",\n \"https://mail.google.com/\"\n ]\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "connection-123",
"projectId": "project-456",
"provider": "salesforce",
"group": {
"groupRef": "group-123",
"groupName": "Super Customer",
"projectId": "project-456",
"createTime": "2023-07-13T21:34:44.816354Z",
"updateTime": "2023-07-13T21:34:44.816354Z"
},
"consumer": {
"consumerRef": "consumer-123",
"consumerName": "Super Customer",
"projectId": "project-456",
"createTime": "2023-07-13T21:34:44.816354Z",
"updateTime": "2023-07-13T21:34:44.816354Z"
},
"createTime": "2023-07-13T21:34:44.816354Z",
"authScheme": "oauth2/authorizationCode",
"status": "working",
"providerApp": {
"id": "provider-app-123",
"projectId": "project-456",
"provider": "salesforce",
"clientId": "client-id-123",
"createTime": "2023-11-07T05:31:56Z",
"externalRef": "external-id-123",
"scopes": [
[
"oauth",
"offline",
"crm.read"
]
],
"metadata": {
"authQueryParams": {
"optional_scope": [
"automation.sequences.read"
]
},
"providerParams": {
"packageInstallURL": "https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789",
"gcpProjectId": "my-gcp-project",
"gcpPubSubTopicName": "my-topic"
}
},
"updateTime": "2023-11-07T05:31:56Z"
},
"providerWorkspaceRef": "provider-workspace-123",
"providerConsumerRef": "provider-consumer-123",
"updateTime": "2023-07-13T21:34:44.816354Z",
"oauth2AuthorizationCode": {
"accessToken": {
"token": "<string>",
"issuedAt": "2024-04-22T18:55:28.456076Z",
"expiresAt": "2024-10-22T18:55:28.456076Z"
},
"refreshToken": {
"token": "<string>",
"issuedAt": "2024-04-22T18:55:28.456076Z",
"expiresAt": "2024-10-22T18:55:28.456076Z"
},
"scopes": [
"<string>"
]
},
"apiKey": "api-key-123",
"providerMetadata": {}
}{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}{
"type": "urn:problem-type:exampleOrganization:exampleProblem",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Description of the type of problem that occurred",
"status": 400,
"detail": "Description of specific occurrence of the problem",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}Connection
Generate a new connection
All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the /oauth-connect endpoint instead, unless you already have the refresh token and are importing it into Ampersand.
POST
/
projects
/
{projectIdOrName}
/
connections:generate
Generate a new connection
curl --request POST \
--url https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"groupRef": "group-123",
"consumerRef": "<string>",
"provider": "<string>",
"providerWorkspaceRef": "<string>",
"providerMetadata": {},
"groupName": "<string>",
"consumerName": "<string>",
"apiKey": "<string>",
"customAuth": {
"serviceAccountKey": "base64encodedkey",
"scopes": [
"https://www.googleapis.com/auth/calendar",
"https://mail.google.com/"
]
},
"oauth2AuthorizationCode": {
"scopes": [
"<string>"
]
}
}
'import requests
url = "https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate"
payload = {
"groupRef": "group-123",
"consumerRef": "<string>",
"provider": "<string>",
"providerWorkspaceRef": "<string>",
"providerMetadata": {},
"groupName": "<string>",
"consumerName": "<string>",
"apiKey": "<string>",
"customAuth": {
"serviceAccountKey": "base64encodedkey",
"scopes": ["https://www.googleapis.com/auth/calendar", "https://mail.google.com/"]
},
"oauth2AuthorizationCode": { "scopes": ["<string>"] }
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groupRef: 'group-123',
consumerRef: '<string>',
provider: '<string>',
providerWorkspaceRef: '<string>',
providerMetadata: {},
groupName: '<string>',
consumerName: '<string>',
apiKey: '<string>',
customAuth: {
serviceAccountKey: 'base64encodedkey',
scopes: ['https://www.googleapis.com/auth/calendar', 'https://mail.google.com/']
},
oauth2AuthorizationCode: {scopes: ['<string>']}
})
};
fetch('https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'groupRef' => 'group-123',
'consumerRef' => '<string>',
'provider' => '<string>',
'providerWorkspaceRef' => '<string>',
'providerMetadata' => [
],
'groupName' => '<string>',
'consumerName' => '<string>',
'apiKey' => '<string>',
'customAuth' => [
'serviceAccountKey' => 'base64encodedkey',
'scopes' => [
'https://www.googleapis.com/auth/calendar',
'https://mail.google.com/'
]
],
'oauth2AuthorizationCode' => [
'scopes' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate"
payload := strings.NewReader("{\n \"groupRef\": \"group-123\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"consumerName\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"serviceAccountKey\": \"base64encodedkey\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/calendar\",\n \"https://mail.google.com/\"\n ]\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"groupRef\": \"group-123\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"consumerName\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"serviceAccountKey\": \"base64encodedkey\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/calendar\",\n \"https://mail.google.com/\"\n ]\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ampersand.ai/v1/projects/{projectIdOrName}/connections:generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groupRef\": \"group-123\",\n \"consumerRef\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerWorkspaceRef\": \"<string>\",\n \"providerMetadata\": {},\n \"groupName\": \"<string>\",\n \"consumerName\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"customAuth\": {\n \"serviceAccountKey\": \"base64encodedkey\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/calendar\",\n \"https://mail.google.com/\"\n ]\n },\n \"oauth2AuthorizationCode\": {\n \"scopes\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "connection-123",
"projectId": "project-456",
"provider": "salesforce",
"group": {
"groupRef": "group-123",
"groupName": "Super Customer",
"projectId": "project-456",
"createTime": "2023-07-13T21:34:44.816354Z",
"updateTime": "2023-07-13T21:34:44.816354Z"
},
"consumer": {
"consumerRef": "consumer-123",
"consumerName": "Super Customer",
"projectId": "project-456",
"createTime": "2023-07-13T21:34:44.816354Z",
"updateTime": "2023-07-13T21:34:44.816354Z"
},
"createTime": "2023-07-13T21:34:44.816354Z",
"authScheme": "oauth2/authorizationCode",
"status": "working",
"providerApp": {
"id": "provider-app-123",
"projectId": "project-456",
"provider": "salesforce",
"clientId": "client-id-123",
"createTime": "2023-11-07T05:31:56Z",
"externalRef": "external-id-123",
"scopes": [
[
"oauth",
"offline",
"crm.read"
]
],
"metadata": {
"authQueryParams": {
"optional_scope": [
"automation.sequences.read"
]
},
"providerParams": {
"packageInstallURL": "https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789",
"gcpProjectId": "my-gcp-project",
"gcpPubSubTopicName": "my-topic"
}
},
"updateTime": "2023-11-07T05:31:56Z"
},
"providerWorkspaceRef": "provider-workspace-123",
"providerConsumerRef": "provider-consumer-123",
"updateTime": "2023-07-13T21:34:44.816354Z",
"oauth2AuthorizationCode": {
"accessToken": {
"token": "<string>",
"issuedAt": "2024-04-22T18:55:28.456076Z",
"expiresAt": "2024-10-22T18:55:28.456076Z"
},
"refreshToken": {
"token": "<string>",
"issuedAt": "2024-04-22T18:55:28.456076Z",
"expiresAt": "2024-10-22T18:55:28.456076Z"
},
"scopes": [
"<string>"
]
},
"apiKey": "api-key-123",
"providerMetadata": {}
}{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}{
"type": "urn:problem-type:exampleOrganization:exampleProblem",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Description of the type of problem that occurred",
"status": 400,
"detail": "Description of specific occurrence of the problem",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}Body
application/json
Values used for custom auth input variables. Most values are strings (API keys, tokens, etc.), but structured values like arrays are also accepted — for example, googleWorkspaceDelegation sends a scopes array alongside the service account key.
Example:
{
"serviceAccountKey": "base64encodedkey",
"scopes": [
"https://www.googleapis.com/auth/calendar",
"https://mail.google.com/"
]
}
Response
Created
The status of the connection.
created: The connection has just been created or the access token was just refreshed.working: The connection has successfully been used to make a request.bad_credentials: The connection encountered credential-related issues when making a request, or when attempting to refresh the access token.
Available options:
created, working, bad_credentials Example:
"working"
If available, the ID that Salesforce/Hubspot uses to identify this user (e.g. Salesforce has IDs in the form of https://login.salesforce.com/id/00D4x0000019CQTEA2/0054x000000orJ4AA)
Example:
"provider-consumer-123"
Was this page helpful?

