Integrations
Update Integration
Update an Integration. The response masks client_id and client_secret: **** plus its last four characters when it is at least 16 characters long, otherwise ****. Sending a masked value back leaves the stored value unchanged; send a new value to replace it.
PUT
/
api
/
integrations
/
{heron_id}
Update Integration
curl --request PUT \
--url https://app.herondata.io/api/integrations/{heron_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"integration": {
"base_url": "<string>",
"client_auth": {},
"client_id": "<string>",
"client_secret": "<string>",
"name": "<string>",
"setup_metadata": {},
"type": "<string>",
"webhook_url": "<string>"
}
}
'import requests
url = "https://app.herondata.io/api/integrations/{heron_id}"
payload = { "integration": {
"base_url": "<string>",
"client_auth": {},
"client_id": "<string>",
"client_secret": "<string>",
"name": "<string>",
"setup_metadata": {},
"type": "<string>",
"webhook_url": "<string>"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integration: {
base_url: '<string>',
client_auth: {},
client_id: '<string>',
client_secret: '<string>',
name: '<string>',
setup_metadata: {},
type: '<string>',
webhook_url: '<string>'
}
})
};
fetch('https://app.herondata.io/api/integrations/{heron_id}', 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://app.herondata.io/api/integrations/{heron_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'integration' => [
'base_url' => '<string>',
'client_auth' => [
],
'client_id' => '<string>',
'client_secret' => '<string>',
'name' => '<string>',
'setup_metadata' => [
],
'type' => '<string>',
'webhook_url' => '<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://app.herondata.io/api/integrations/{heron_id}"
payload := strings.NewReader("{\n \"integration\": {\n \"base_url\": \"<string>\",\n \"client_auth\": {},\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"name\": \"<string>\",\n \"setup_metadata\": {},\n \"type\": \"<string>\",\n \"webhook_url\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.herondata.io/api/integrations/{heron_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integration\": {\n \"base_url\": \"<string>\",\n \"client_auth\": {},\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"name\": \"<string>\",\n \"setup_metadata\": {},\n \"type\": \"<string>\",\n \"webhook_url\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/integrations/{heron_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration\": {\n \"base_url\": \"<string>\",\n \"client_auth\": {},\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"name\": \"<string>\",\n \"setup_metadata\": {},\n \"type\": \"<string>\",\n \"webhook_url\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"integration": {
"name": "Plaid Prod",
"resource": "transaction",
"type": "<string>",
"base_url": "https://sandbox.plaid.com",
"client_id": "<string>",
"client_secret": "<string>",
"heron_id": "<string>",
"setup_metadata": {},
"webhook_url": "https://your-server.yourdomain.com/hooks"
}
}Was this page helpful?
⌘I
Update Integration
curl --request PUT \
--url https://app.herondata.io/api/integrations/{heron_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"integration": {
"base_url": "<string>",
"client_auth": {},
"client_id": "<string>",
"client_secret": "<string>",
"name": "<string>",
"setup_metadata": {},
"type": "<string>",
"webhook_url": "<string>"
}
}
'import requests
url = "https://app.herondata.io/api/integrations/{heron_id}"
payload = { "integration": {
"base_url": "<string>",
"client_auth": {},
"client_id": "<string>",
"client_secret": "<string>",
"name": "<string>",
"setup_metadata": {},
"type": "<string>",
"webhook_url": "<string>"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integration: {
base_url: '<string>',
client_auth: {},
client_id: '<string>',
client_secret: '<string>',
name: '<string>',
setup_metadata: {},
type: '<string>',
webhook_url: '<string>'
}
})
};
fetch('https://app.herondata.io/api/integrations/{heron_id}', 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://app.herondata.io/api/integrations/{heron_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'integration' => [
'base_url' => '<string>',
'client_auth' => [
],
'client_id' => '<string>',
'client_secret' => '<string>',
'name' => '<string>',
'setup_metadata' => [
],
'type' => '<string>',
'webhook_url' => '<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://app.herondata.io/api/integrations/{heron_id}"
payload := strings.NewReader("{\n \"integration\": {\n \"base_url\": \"<string>\",\n \"client_auth\": {},\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"name\": \"<string>\",\n \"setup_metadata\": {},\n \"type\": \"<string>\",\n \"webhook_url\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.herondata.io/api/integrations/{heron_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integration\": {\n \"base_url\": \"<string>\",\n \"client_auth\": {},\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"name\": \"<string>\",\n \"setup_metadata\": {},\n \"type\": \"<string>\",\n \"webhook_url\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/integrations/{heron_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration\": {\n \"base_url\": \"<string>\",\n \"client_auth\": {},\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"name\": \"<string>\",\n \"setup_metadata\": {},\n \"type\": \"<string>\",\n \"webhook_url\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"integration": {
"name": "Plaid Prod",
"resource": "transaction",
"type": "<string>",
"base_url": "https://sandbox.plaid.com",
"client_id": "<string>",
"client_secret": "<string>",
"heron_id": "<string>",
"setup_metadata": {},
"webhook_url": "https://your-server.yourdomain.com/hooks"
}
}