Authenticated Passthrough Request
Learn how to make a new authenticated request to the integration API using stored linked account credentials
Using cobalt's authenticated passthrough request, you can make requests directly to an application API.
Cobalt makes it easy to make API requests to any of cobalt's supported integrations with the account tokens that you've stored on behalf of your users. These requests are sent directly to the application API and follow each applications specific API formats. This approach is ideal for when you're looking to fetch data that Cobalt may not support.
Send POST requests to the URL below with the required body parameters to create a passthrough request.
post
https://api.gocobalt.io
/api/v1/passthrough
Send POST requests to the URL below with the required body parameters to create a passthrough request
Parameters
Header
linked_account_id*
String
Linked account of the connected user
x-api-key*
String
Your unique api key
Content-Type*
String
Pass "application/json"
Body
path*
String
The path for the third part request, such as /user
integration_type*
String
Name of the application such as mailchimp, salesforce etc
method*
String
The method for the third-party request, such as GET or POST.
baseurl*
String
The base Url for the third-party request, such as https://api.mailchimp.com.
data
String
The data for the request body. Generally needed for POST & PUT request
url_params
Object
Refer the API docs of the selected app to pass query params in the request UrL if needed
query_string
Object
Refer the API docs of the selected app to pass query params in the request UrL if needed
headers
Object
Only if extra details are required to pass in the headers
Responses
200: OK
Sample response to your passthrough request
// Example GET Request
{
"integration_type": "mailchimp",
"baseurl": "https://us9.api.mailchimp.com",
"path": "/3.0/lists",
"method": "get",
"query_string": {
'limit':10
},
"headers": {
'version':2
}
}
// Example POST Request
{
"integration_type": "mailchimp",
"baseurl": "https://us9.api.mailchimp.com",
"path": "/3.0/lists",
"method": "post",
"body": {
"list_name":'Sample List'
},
"headers": {
'version':2
}
}
Last modified 3mo ago