create-connection
curl --request POST \
--url https://api.getmembrane.com/connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"meta": {},
"authOptionKey": "<string>",
"key": "<string>",
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"connectorId": "<string>",
"connectorUuid": "<string>",
"connectorKey": "<string>",
"connectorVersion": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"credentials": "<unknown>",
"connectorParameters": "<unknown>",
"input": "<unknown>",
"intent": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logoUri": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"appUuid": "<string>",
"categories": [
"<string>"
],
"authOptions": "<unknown>",
"customCredentialsSchema": {},
"inputSchema": {},
"parametersSchema": {},
"getCredentialsFromConnectionParameters": {
"description": "<string>"
},
"refreshCredentials": {
"description": "<string>"
},
"makeApiClient": {
"description": "<string>"
},
"getOAuthConfig": {
"description": "<string>"
},
"getTokenData": {
"description": "<string>"
},
"getCredentialsFromAccessTokenResponse": {
"description": "<string>"
},
"getCredentialsFromRefreshTokenResponse": {
"description": "<string>"
},
"test": {
"description": "<string>"
},
"disconnect": {
"description": "<string>"
},
"proxyKey": "<string>",
"ui": {
"schema": {},
"description": "<string>",
"helpUri": "<string>"
},
"options": {}
},
"externalApp": {
"key": "<string>",
"name": "<string>",
"appUri": "<string>",
"logoUri": "<string>",
"categories": [
"<string>"
],
"defaultConnectorId": "<string>",
"basePackageId": "<string>",
"hasFreeTestAccount": true,
"freeTestAccountGuide": "<string>",
"freeTestAccountGuideVerifiedAt": "2023-11-07T05:31:56Z",
"tenantId": "<string>"
},
"appUrl": "<string>"
}
'import requests
url = "https://api.getmembrane.com/connections"
payload = {
"name": "<string>",
"meta": {},
"authOptionKey": "<string>",
"key": "<string>",
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"connectorId": "<string>",
"connectorUuid": "<string>",
"connectorKey": "<string>",
"connectorVersion": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"credentials": "<unknown>",
"connectorParameters": "<unknown>",
"input": "<unknown>",
"intent": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logoUri": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"appUuid": "<string>",
"categories": ["<string>"],
"authOptions": "<unknown>",
"customCredentialsSchema": {},
"inputSchema": {},
"parametersSchema": {},
"getCredentialsFromConnectionParameters": { "description": "<string>" },
"refreshCredentials": { "description": "<string>" },
"makeApiClient": { "description": "<string>" },
"getOAuthConfig": { "description": "<string>" },
"getTokenData": { "description": "<string>" },
"getCredentialsFromAccessTokenResponse": { "description": "<string>" },
"getCredentialsFromRefreshTokenResponse": { "description": "<string>" },
"test": { "description": "<string>" },
"disconnect": { "description": "<string>" },
"proxyKey": "<string>",
"ui": {
"schema": {},
"description": "<string>",
"helpUri": "<string>"
},
"options": {}
},
"externalApp": {
"key": "<string>",
"name": "<string>",
"appUri": "<string>",
"logoUri": "<string>",
"categories": ["<string>"],
"defaultConnectorId": "<string>",
"basePackageId": "<string>",
"hasFreeTestAccount": True,
"freeTestAccountGuide": "<string>",
"freeTestAccountGuideVerifiedAt": "2023-11-07T05:31:56Z",
"tenantId": "<string>"
},
"appUrl": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
meta: {},
authOptionKey: '<string>',
key: '<string>',
integrationId: '<string>',
integrationUuid: '<string>',
integrationKey: '<string>',
connectorId: '<string>',
connectorUuid: '<string>',
connectorKey: '<string>',
connectorVersion: '<string>',
externalAppId: '<string>',
externalAppUuid: '<string>',
credentials: '<unknown>',
connectorParameters: '<unknown>',
input: '<unknown>',
intent: '<string>',
connector: {
key: '<string>',
name: '<string>',
logoUri: '<string>',
externalAppId: '<string>',
externalAppUuid: '<string>',
appUuid: '<string>',
categories: ['<string>'],
authOptions: '<unknown>',
customCredentialsSchema: {},
inputSchema: {},
parametersSchema: {},
getCredentialsFromConnectionParameters: {description: '<string>'},
refreshCredentials: {description: '<string>'},
makeApiClient: {description: '<string>'},
getOAuthConfig: {description: '<string>'},
getTokenData: {description: '<string>'},
getCredentialsFromAccessTokenResponse: {description: '<string>'},
getCredentialsFromRefreshTokenResponse: {description: '<string>'},
test: {description: '<string>'},
disconnect: {description: '<string>'},
proxyKey: '<string>',
ui: {schema: {}, description: '<string>', helpUri: '<string>'},
options: {}
},
externalApp: {
key: '<string>',
name: '<string>',
appUri: '<string>',
logoUri: '<string>',
categories: ['<string>'],
defaultConnectorId: '<string>',
basePackageId: '<string>',
hasFreeTestAccount: true,
freeTestAccountGuide: '<string>',
freeTestAccountGuideVerifiedAt: '2023-11-07T05:31:56Z',
tenantId: '<string>'
},
appUrl: '<string>'
})
};
fetch('https://api.getmembrane.com/connections', 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.getmembrane.com/connections",
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([
'name' => '<string>',
'meta' => [
],
'authOptionKey' => '<string>',
'key' => '<string>',
'integrationId' => '<string>',
'integrationUuid' => '<string>',
'integrationKey' => '<string>',
'connectorId' => '<string>',
'connectorUuid' => '<string>',
'connectorKey' => '<string>',
'connectorVersion' => '<string>',
'externalAppId' => '<string>',
'externalAppUuid' => '<string>',
'credentials' => '<unknown>',
'connectorParameters' => '<unknown>',
'input' => '<unknown>',
'intent' => '<string>',
'connector' => [
'key' => '<string>',
'name' => '<string>',
'logoUri' => '<string>',
'externalAppId' => '<string>',
'externalAppUuid' => '<string>',
'appUuid' => '<string>',
'categories' => [
'<string>'
],
'authOptions' => '<unknown>',
'customCredentialsSchema' => [
],
'inputSchema' => [
],
'parametersSchema' => [
],
'getCredentialsFromConnectionParameters' => [
'description' => '<string>'
],
'refreshCredentials' => [
'description' => '<string>'
],
'makeApiClient' => [
'description' => '<string>'
],
'getOAuthConfig' => [
'description' => '<string>'
],
'getTokenData' => [
'description' => '<string>'
],
'getCredentialsFromAccessTokenResponse' => [
'description' => '<string>'
],
'getCredentialsFromRefreshTokenResponse' => [
'description' => '<string>'
],
'test' => [
'description' => '<string>'
],
'disconnect' => [
'description' => '<string>'
],
'proxyKey' => '<string>',
'ui' => [
'schema' => [
],
'description' => '<string>',
'helpUri' => '<string>'
],
'options' => [
]
],
'externalApp' => [
'key' => '<string>',
'name' => '<string>',
'appUri' => '<string>',
'logoUri' => '<string>',
'categories' => [
'<string>'
],
'defaultConnectorId' => '<string>',
'basePackageId' => '<string>',
'hasFreeTestAccount' => true,
'freeTestAccountGuide' => '<string>',
'freeTestAccountGuideVerifiedAt' => '2023-11-07T05:31:56Z',
'tenantId' => '<string>'
],
'appUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.getmembrane.com/connections"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": \"<unknown>\",\n \"connectorParameters\": \"<unknown>\",\n \"input\": \"<unknown>\",\n \"intent\": \"<string>\",\n \"connector\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"appUuid\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"authOptions\": \"<unknown>\",\n \"customCredentialsSchema\": {},\n \"inputSchema\": {},\n \"parametersSchema\": {},\n \"getCredentialsFromConnectionParameters\": {\n \"description\": \"<string>\"\n },\n \"refreshCredentials\": {\n \"description\": \"<string>\"\n },\n \"makeApiClient\": {\n \"description\": \"<string>\"\n },\n \"getOAuthConfig\": {\n \"description\": \"<string>\"\n },\n \"getTokenData\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromAccessTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromRefreshTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"test\": {\n \"description\": \"<string>\"\n },\n \"disconnect\": {\n \"description\": \"<string>\"\n },\n \"proxyKey\": \"<string>\",\n \"ui\": {\n \"schema\": {},\n \"description\": \"<string>\",\n \"helpUri\": \"<string>\"\n },\n \"options\": {}\n },\n \"externalApp\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n },\n \"appUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.getmembrane.com/connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": \"<unknown>\",\n \"connectorParameters\": \"<unknown>\",\n \"input\": \"<unknown>\",\n \"intent\": \"<string>\",\n \"connector\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"appUuid\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"authOptions\": \"<unknown>\",\n \"customCredentialsSchema\": {},\n \"inputSchema\": {},\n \"parametersSchema\": {},\n \"getCredentialsFromConnectionParameters\": {\n \"description\": \"<string>\"\n },\n \"refreshCredentials\": {\n \"description\": \"<string>\"\n },\n \"makeApiClient\": {\n \"description\": \"<string>\"\n },\n \"getOAuthConfig\": {\n \"description\": \"<string>\"\n },\n \"getTokenData\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromAccessTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromRefreshTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"test\": {\n \"description\": \"<string>\"\n },\n \"disconnect\": {\n \"description\": \"<string>\"\n },\n \"proxyKey\": \"<string>\",\n \"ui\": {\n \"schema\": {},\n \"description\": \"<string>\",\n \"helpUri\": \"<string>\"\n },\n \"options\": {}\n },\n \"externalApp\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n },\n \"appUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmembrane.com/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": \"<unknown>\",\n \"connectorParameters\": \"<unknown>\",\n \"input\": \"<unknown>\",\n \"intent\": \"<string>\",\n \"connector\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"appUuid\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"authOptions\": \"<unknown>\",\n \"customCredentialsSchema\": {},\n \"inputSchema\": {},\n \"parametersSchema\": {},\n \"getCredentialsFromConnectionParameters\": {\n \"description\": \"<string>\"\n },\n \"refreshCredentials\": {\n \"description\": \"<string>\"\n },\n \"makeApiClient\": {\n \"description\": \"<string>\"\n },\n \"getOAuthConfig\": {\n \"description\": \"<string>\"\n },\n \"getTokenData\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromAccessTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromRefreshTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"test\": {\n \"description\": \"<string>\"\n },\n \"disconnect\": {\n \"description\": \"<string>\"\n },\n \"proxyKey\": \"<string>\",\n \"ui\": {\n \"schema\": {},\n \"description\": \"<string>\",\n \"helpUri\": \"<string>\"\n },\n \"options\": {}\n },\n \"externalApp\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n },\n \"appUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"userId": "<string>",
"tenantId": "<string>",
"ownerName": "<string>",
"key": "<string>",
"isTest": true,
"connected": true,
"hasDocs": true,
"docsCount": 123,
"docsSummary": "<string>",
"errors": [
{}
],
"requestError": {},
"integrationId": "<string>",
"connectorId": "<string>",
"externalAppId": "<string>",
"connectorVersion": "<string>",
"authOptionKey": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"lastActiveAt": "<string>",
"nextCredentialsRefreshAt": "<string>",
"nextRetryTimestamp": "<string>",
"retryAttempts": 123,
"canTest": true,
"canRefreshCredentials": true,
"archivedAt": "<string>",
"isDeactivated": true,
"meta": {},
"buildingAgentSessionId": "<string>",
"clientAction": {
"description": "<string>",
"uiUrl": "<string>",
"agentInstructions": "<string>",
"handoffAgentInstructions": "<string>"
},
"logoUri": "<string>",
"input": "<unknown>"
}Connections
create-connection
Create (or reconnect) a connection to an external app. Identify the target by a connector/integration/app identifier, or by appUrl (a URL/domain like “https://slack.com”) — appUrl reuses an existing connection for that app under the tenant if one exists, otherwise creates one. When you have them, pass input / connectorParameters / credentials to set auth up front. When you have the app’s API docs, build its connector yourself by passing the connector (and externalApp) by value here — that creates the connection and connector together with your docs preserved. Use intent only as a last resort for an app you have NO docs for: it spawns a separate connector build that never sees docs you already hold. Returns the connection with its state and, while the user still needs to act, a clientAction. For a user-facing connect button, offer connect instead.
POST
/
connections
create-connection
curl --request POST \
--url https://api.getmembrane.com/connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"meta": {},
"authOptionKey": "<string>",
"key": "<string>",
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"connectorId": "<string>",
"connectorUuid": "<string>",
"connectorKey": "<string>",
"connectorVersion": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"credentials": "<unknown>",
"connectorParameters": "<unknown>",
"input": "<unknown>",
"intent": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logoUri": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"appUuid": "<string>",
"categories": [
"<string>"
],
"authOptions": "<unknown>",
"customCredentialsSchema": {},
"inputSchema": {},
"parametersSchema": {},
"getCredentialsFromConnectionParameters": {
"description": "<string>"
},
"refreshCredentials": {
"description": "<string>"
},
"makeApiClient": {
"description": "<string>"
},
"getOAuthConfig": {
"description": "<string>"
},
"getTokenData": {
"description": "<string>"
},
"getCredentialsFromAccessTokenResponse": {
"description": "<string>"
},
"getCredentialsFromRefreshTokenResponse": {
"description": "<string>"
},
"test": {
"description": "<string>"
},
"disconnect": {
"description": "<string>"
},
"proxyKey": "<string>",
"ui": {
"schema": {},
"description": "<string>",
"helpUri": "<string>"
},
"options": {}
},
"externalApp": {
"key": "<string>",
"name": "<string>",
"appUri": "<string>",
"logoUri": "<string>",
"categories": [
"<string>"
],
"defaultConnectorId": "<string>",
"basePackageId": "<string>",
"hasFreeTestAccount": true,
"freeTestAccountGuide": "<string>",
"freeTestAccountGuideVerifiedAt": "2023-11-07T05:31:56Z",
"tenantId": "<string>"
},
"appUrl": "<string>"
}
'import requests
url = "https://api.getmembrane.com/connections"
payload = {
"name": "<string>",
"meta": {},
"authOptionKey": "<string>",
"key": "<string>",
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"connectorId": "<string>",
"connectorUuid": "<string>",
"connectorKey": "<string>",
"connectorVersion": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"credentials": "<unknown>",
"connectorParameters": "<unknown>",
"input": "<unknown>",
"intent": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logoUri": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"appUuid": "<string>",
"categories": ["<string>"],
"authOptions": "<unknown>",
"customCredentialsSchema": {},
"inputSchema": {},
"parametersSchema": {},
"getCredentialsFromConnectionParameters": { "description": "<string>" },
"refreshCredentials": { "description": "<string>" },
"makeApiClient": { "description": "<string>" },
"getOAuthConfig": { "description": "<string>" },
"getTokenData": { "description": "<string>" },
"getCredentialsFromAccessTokenResponse": { "description": "<string>" },
"getCredentialsFromRefreshTokenResponse": { "description": "<string>" },
"test": { "description": "<string>" },
"disconnect": { "description": "<string>" },
"proxyKey": "<string>",
"ui": {
"schema": {},
"description": "<string>",
"helpUri": "<string>"
},
"options": {}
},
"externalApp": {
"key": "<string>",
"name": "<string>",
"appUri": "<string>",
"logoUri": "<string>",
"categories": ["<string>"],
"defaultConnectorId": "<string>",
"basePackageId": "<string>",
"hasFreeTestAccount": True,
"freeTestAccountGuide": "<string>",
"freeTestAccountGuideVerifiedAt": "2023-11-07T05:31:56Z",
"tenantId": "<string>"
},
"appUrl": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
meta: {},
authOptionKey: '<string>',
key: '<string>',
integrationId: '<string>',
integrationUuid: '<string>',
integrationKey: '<string>',
connectorId: '<string>',
connectorUuid: '<string>',
connectorKey: '<string>',
connectorVersion: '<string>',
externalAppId: '<string>',
externalAppUuid: '<string>',
credentials: '<unknown>',
connectorParameters: '<unknown>',
input: '<unknown>',
intent: '<string>',
connector: {
key: '<string>',
name: '<string>',
logoUri: '<string>',
externalAppId: '<string>',
externalAppUuid: '<string>',
appUuid: '<string>',
categories: ['<string>'],
authOptions: '<unknown>',
customCredentialsSchema: {},
inputSchema: {},
parametersSchema: {},
getCredentialsFromConnectionParameters: {description: '<string>'},
refreshCredentials: {description: '<string>'},
makeApiClient: {description: '<string>'},
getOAuthConfig: {description: '<string>'},
getTokenData: {description: '<string>'},
getCredentialsFromAccessTokenResponse: {description: '<string>'},
getCredentialsFromRefreshTokenResponse: {description: '<string>'},
test: {description: '<string>'},
disconnect: {description: '<string>'},
proxyKey: '<string>',
ui: {schema: {}, description: '<string>', helpUri: '<string>'},
options: {}
},
externalApp: {
key: '<string>',
name: '<string>',
appUri: '<string>',
logoUri: '<string>',
categories: ['<string>'],
defaultConnectorId: '<string>',
basePackageId: '<string>',
hasFreeTestAccount: true,
freeTestAccountGuide: '<string>',
freeTestAccountGuideVerifiedAt: '2023-11-07T05:31:56Z',
tenantId: '<string>'
},
appUrl: '<string>'
})
};
fetch('https://api.getmembrane.com/connections', 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.getmembrane.com/connections",
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([
'name' => '<string>',
'meta' => [
],
'authOptionKey' => '<string>',
'key' => '<string>',
'integrationId' => '<string>',
'integrationUuid' => '<string>',
'integrationKey' => '<string>',
'connectorId' => '<string>',
'connectorUuid' => '<string>',
'connectorKey' => '<string>',
'connectorVersion' => '<string>',
'externalAppId' => '<string>',
'externalAppUuid' => '<string>',
'credentials' => '<unknown>',
'connectorParameters' => '<unknown>',
'input' => '<unknown>',
'intent' => '<string>',
'connector' => [
'key' => '<string>',
'name' => '<string>',
'logoUri' => '<string>',
'externalAppId' => '<string>',
'externalAppUuid' => '<string>',
'appUuid' => '<string>',
'categories' => [
'<string>'
],
'authOptions' => '<unknown>',
'customCredentialsSchema' => [
],
'inputSchema' => [
],
'parametersSchema' => [
],
'getCredentialsFromConnectionParameters' => [
'description' => '<string>'
],
'refreshCredentials' => [
'description' => '<string>'
],
'makeApiClient' => [
'description' => '<string>'
],
'getOAuthConfig' => [
'description' => '<string>'
],
'getTokenData' => [
'description' => '<string>'
],
'getCredentialsFromAccessTokenResponse' => [
'description' => '<string>'
],
'getCredentialsFromRefreshTokenResponse' => [
'description' => '<string>'
],
'test' => [
'description' => '<string>'
],
'disconnect' => [
'description' => '<string>'
],
'proxyKey' => '<string>',
'ui' => [
'schema' => [
],
'description' => '<string>',
'helpUri' => '<string>'
],
'options' => [
]
],
'externalApp' => [
'key' => '<string>',
'name' => '<string>',
'appUri' => '<string>',
'logoUri' => '<string>',
'categories' => [
'<string>'
],
'defaultConnectorId' => '<string>',
'basePackageId' => '<string>',
'hasFreeTestAccount' => true,
'freeTestAccountGuide' => '<string>',
'freeTestAccountGuideVerifiedAt' => '2023-11-07T05:31:56Z',
'tenantId' => '<string>'
],
'appUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.getmembrane.com/connections"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": \"<unknown>\",\n \"connectorParameters\": \"<unknown>\",\n \"input\": \"<unknown>\",\n \"intent\": \"<string>\",\n \"connector\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"appUuid\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"authOptions\": \"<unknown>\",\n \"customCredentialsSchema\": {},\n \"inputSchema\": {},\n \"parametersSchema\": {},\n \"getCredentialsFromConnectionParameters\": {\n \"description\": \"<string>\"\n },\n \"refreshCredentials\": {\n \"description\": \"<string>\"\n },\n \"makeApiClient\": {\n \"description\": \"<string>\"\n },\n \"getOAuthConfig\": {\n \"description\": \"<string>\"\n },\n \"getTokenData\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromAccessTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromRefreshTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"test\": {\n \"description\": \"<string>\"\n },\n \"disconnect\": {\n \"description\": \"<string>\"\n },\n \"proxyKey\": \"<string>\",\n \"ui\": {\n \"schema\": {},\n \"description\": \"<string>\",\n \"helpUri\": \"<string>\"\n },\n \"options\": {}\n },\n \"externalApp\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n },\n \"appUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.getmembrane.com/connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": \"<unknown>\",\n \"connectorParameters\": \"<unknown>\",\n \"input\": \"<unknown>\",\n \"intent\": \"<string>\",\n \"connector\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"appUuid\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"authOptions\": \"<unknown>\",\n \"customCredentialsSchema\": {},\n \"inputSchema\": {},\n \"parametersSchema\": {},\n \"getCredentialsFromConnectionParameters\": {\n \"description\": \"<string>\"\n },\n \"refreshCredentials\": {\n \"description\": \"<string>\"\n },\n \"makeApiClient\": {\n \"description\": \"<string>\"\n },\n \"getOAuthConfig\": {\n \"description\": \"<string>\"\n },\n \"getTokenData\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromAccessTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromRefreshTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"test\": {\n \"description\": \"<string>\"\n },\n \"disconnect\": {\n \"description\": \"<string>\"\n },\n \"proxyKey\": \"<string>\",\n \"ui\": {\n \"schema\": {},\n \"description\": \"<string>\",\n \"helpUri\": \"<string>\"\n },\n \"options\": {}\n },\n \"externalApp\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n },\n \"appUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmembrane.com/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": \"<unknown>\",\n \"connectorParameters\": \"<unknown>\",\n \"input\": \"<unknown>\",\n \"intent\": \"<string>\",\n \"connector\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"appUuid\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"authOptions\": \"<unknown>\",\n \"customCredentialsSchema\": {},\n \"inputSchema\": {},\n \"parametersSchema\": {},\n \"getCredentialsFromConnectionParameters\": {\n \"description\": \"<string>\"\n },\n \"refreshCredentials\": {\n \"description\": \"<string>\"\n },\n \"makeApiClient\": {\n \"description\": \"<string>\"\n },\n \"getOAuthConfig\": {\n \"description\": \"<string>\"\n },\n \"getTokenData\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromAccessTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"getCredentialsFromRefreshTokenResponse\": {\n \"description\": \"<string>\"\n },\n \"test\": {\n \"description\": \"<string>\"\n },\n \"disconnect\": {\n \"description\": \"<string>\"\n },\n \"proxyKey\": \"<string>\",\n \"ui\": {\n \"schema\": {},\n \"description\": \"<string>\",\n \"helpUri\": \"<string>\"\n },\n \"options\": {}\n },\n \"externalApp\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n },\n \"appUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"userId": "<string>",
"tenantId": "<string>",
"ownerName": "<string>",
"key": "<string>",
"isTest": true,
"connected": true,
"hasDocs": true,
"docsCount": 123,
"docsSummary": "<string>",
"errors": [
{}
],
"requestError": {},
"integrationId": "<string>",
"connectorId": "<string>",
"externalAppId": "<string>",
"connectorVersion": "<string>",
"authOptionKey": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"lastActiveAt": "<string>",
"nextCredentialsRefreshAt": "<string>",
"nextRetryTimestamp": "<string>",
"retryAttempts": 123,
"canTest": true,
"canRefreshCredentials": true,
"archivedAt": "<string>",
"isDeactivated": true,
"meta": {},
"buildingAgentSessionId": "<string>",
"clientAction": {
"description": "<string>",
"uiUrl": "<string>",
"agentInstructions": "<string>",
"handoffAgentInstructions": "<string>"
},
"logoUri": "<string>",
"input": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Available options:
connector, mcp, pipedream Show child attributes
Show child attributes
Required string length:
1 - 100[Experimental] Intent-based instruction for an agent to configure this element.
Connector to build or edit inline. Creates and links a new connector when the connection has no connectorId; updates the linked connector when it does. Same shape as the connector write API.
Show child attributes
Show child attributes
External app to create or edit inline. Creates and links a new app when the connection has no externalAppId; updates the linked app when it does. Same shape as the external-app write API.
Show child attributes
Show child attributes
URL or domain of the app to connect to (e.g. "https://slack.com" or "slack.com"). Resolved to an external app server-side before creating a connection.
Required string length:
1 - 2000Response
200 - application/json
Create (or reconnect) a connection to an external app. Identify the target by a connector/integration/app identifier, or by appUrl (a URL/domain like "https://slack.com") — appUrl reuses an existing connection for that app under the tenant if one exists, otherwise creates one. When you have them, pass input / connectorParameters / credentials to set auth up front. When you have the app’s API docs, build its connector yourself by passing the connector (and externalApp) by value here — that creates the connection and connector together with your docs preserved. Use intent only as a last resort for an app you have NO docs for: it spawns a separate connector build that never sees docs you already hold. Returns the connection with its state and, while the user still needs to act, a clientAction. For a user-facing connect button, offer connect instead.
Internal database ID of the element. Assigned by the API; unique per element.
Available options:
connector, mcp, pipedream Available options:
BUILDING, CLIENT_ACTION_REQUIRED, CONFIGURATION_ERROR, SETUP_FAILED, READY, DISCONNECTING Show child attributes
Show child attributes
Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.
Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.
Show child attributes
Show child attributes
Resolved app logo for this element (integration -> connector -> external app -> favicon).
⌘I