Create Saas Association

curl --request POST \
  --url https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "association_type_id": "<string>",
  "association_label": "<string>",
  "association_category": "PLATFORM_DEFINED",
  "metadata_": {},
  "relationship_type": "FOREIGN_KEY",
  "status": "SUGGESTED",
  "score": 123,
  "evidence": {},
  "is_active": true
}
'

import requests

url = "https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations"

payload = {
    "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "from_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "to_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "association_type_id": "<string>",
    "association_label": "<string>",
    "association_category": "PLATFORM_DEFINED",
    "metadata_": {},
    "relationship_type": "FOREIGN_KEY",
    "status": "SUGGESTED",
    "score": 123,
    "evidence": {},
    "is_active": True
}
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({
    integration_source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    from_object_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    to_object_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    association_type_id: '<string>',
    association_label: '<string>',
    association_category: 'PLATFORM_DEFINED',
    metadata_: {},
    relationship_type: 'FOREIGN_KEY',
    status: 'SUGGESTED',
    score: 123,
    evidence: {},
    is_active: true
  })
};

fetch('https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations', 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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations",
  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([
    'integration_source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'from_object_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'to_object_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'association_type_id' => '<string>',
    'association_label' => '<string>',
    'association_category' => 'PLATFORM_DEFINED',
    'metadata_' => [
        
    ],
    'relationship_type' => 'FOREIGN_KEY',
    'status' => 'SUGGESTED',
    'score' => 123,
    'evidence' => [
        
    ],
    'is_active' => true
  ]),
  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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations"

	payload := strings.NewReader("{\n  \"integration_source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"from_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"association_type_id\": \"<string>\",\n  \"association_label\": \"<string>\",\n  \"association_category\": \"PLATFORM_DEFINED\",\n  \"metadata_\": {},\n  \"relationship_type\": \"FOREIGN_KEY\",\n  \"status\": \"SUGGESTED\",\n  \"score\": 123,\n  \"evidence\": {},\n  \"is_active\": true\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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration_source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"from_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"association_type_id\": \"<string>\",\n  \"association_label\": \"<string>\",\n  \"association_category\": \"PLATFORM_DEFINED\",\n  \"metadata_\": {},\n  \"relationship_type\": \"FOREIGN_KEY\",\n  \"status\": \"SUGGESTED\",\n  \"score\": 123,\n  \"evidence\": {},\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations")

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  \"integration_source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"from_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"association_type_id\": \"<string>\",\n  \"association_label\": \"<string>\",\n  \"association_category\": \"PLATFORM_DEFINED\",\n  \"metadata_\": {},\n  \"relationship_type\": \"FOREIGN_KEY\",\n  \"status\": \"SUGGESTED\",\n  \"score\": 123,\n  \"evidence\": {},\n  \"is_active\": true\n}"

response = http.request(request)
puts response.read_body

{
  "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "association_type_id": "<string>",
  "association_label": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "association_category": "PLATFORM_DEFINED",
  "metadata_": {},
  "relationship_type": "FOREIGN_KEY",
  "status": "SUGGESTED",
  "score": 123,
  "evidence": {},
  "is_active": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

integration-sources

{source_id}

saas-associations

Create Saas Association

curl --request POST \
  --url https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "association_type_id": "<string>",
  "association_label": "<string>",
  "association_category": "PLATFORM_DEFINED",
  "metadata_": {},
  "relationship_type": "FOREIGN_KEY",
  "status": "SUGGESTED",
  "score": 123,
  "evidence": {},
  "is_active": true
}
'

import requests

url = "https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations"

payload = {
    "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "from_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "to_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "association_type_id": "<string>",
    "association_label": "<string>",
    "association_category": "PLATFORM_DEFINED",
    "metadata_": {},
    "relationship_type": "FOREIGN_KEY",
    "status": "SUGGESTED",
    "score": 123,
    "evidence": {},
    "is_active": True
}
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({
    integration_source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    from_object_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    to_object_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    association_type_id: '<string>',
    association_label: '<string>',
    association_category: 'PLATFORM_DEFINED',
    metadata_: {},
    relationship_type: 'FOREIGN_KEY',
    status: 'SUGGESTED',
    score: 123,
    evidence: {},
    is_active: true
  })
};

fetch('https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations', 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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations",
  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([
    'integration_source_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'from_object_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'to_object_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'association_type_id' => '<string>',
    'association_label' => '<string>',
    'association_category' => 'PLATFORM_DEFINED',
    'metadata_' => [
        
    ],
    'relationship_type' => 'FOREIGN_KEY',
    'status' => 'SUGGESTED',
    'score' => 123,
    'evidence' => [
        
    ],
    'is_active' => true
  ]),
  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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations"

	payload := strings.NewReader("{\n  \"integration_source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"from_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"association_type_id\": \"<string>\",\n  \"association_label\": \"<string>\",\n  \"association_category\": \"PLATFORM_DEFINED\",\n  \"metadata_\": {},\n  \"relationship_type\": \"FOREIGN_KEY\",\n  \"status\": \"SUGGESTED\",\n  \"score\": 123,\n  \"evidence\": {},\n  \"is_active\": true\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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration_source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"from_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"association_type_id\": \"<string>\",\n  \"association_label\": \"<string>\",\n  \"association_category\": \"PLATFORM_DEFINED\",\n  \"metadata_\": {},\n  \"relationship_type\": \"FOREIGN_KEY\",\n  \"status\": \"SUGGESTED\",\n  \"score\": 123,\n  \"evidence\": {},\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations")

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  \"integration_source_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"from_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to_object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"association_type_id\": \"<string>\",\n  \"association_label\": \"<string>\",\n  \"association_category\": \"PLATFORM_DEFINED\",\n  \"metadata_\": {},\n  \"relationship_type\": \"FOREIGN_KEY\",\n  \"status\": \"SUGGESTED\",\n  \"score\": 123,\n  \"evidence\": {},\n  \"is_active\": true\n}"

response = http.request(request)
puts response.read_body

{
  "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "association_type_id": "<string>",
  "association_label": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "association_category": "PLATFORM_DEFINED",
  "metadata_": {},
  "relationship_type": "FOREIGN_KEY",
  "status": "SUGGESTED",
  "score": 123,
  "evidence": {},
  "is_active": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

source_id

string<uuid> | null

required

Query Parameters

organization_id

string<uuid> | null

resource_id

string<uuid> | null

integration_source_id

string<uuid> | null

data_source_id

string<uuid> | null

context_source_id

string<uuid> | null

job_id

string<uuid> | null

Body

application/json

Model for creating a new SaaS association.

integration_source_id

string<uuid>

required

The integration source this association belongs to

from_object_id

string<uuid>

required

The source SaaS object

to_object_id

string<uuid>

required

The target SaaS object

association_type_id

string

required

Platform-specific type identifier (e.g., HubSpot's numeric ID or Salesforce's API name)

association_label

string

required

Human-readable label (e.g., 'Contact to Company')

association_category

string

default:PLATFORM_DEFINED

Category of association (e.g., 'PLATFORM_DEFINED', 'USER_DEFINED', 'CUSTOM')

metadata_

Metadata · object | null

Platform-specific metadata (cardinality hints, bidirectional flags, etc.)

relationship_type

enum<string>

default:FOREIGN_KEY

Relationship type (platform vendor, inferred heuristic, manual override)

Available options:

FOREIGN_KEY,

INFERRED,

MANUAL

status

enum<string>

default:SUGGESTED

Review status for the relationship

Available options:

SUGGESTED,

APPROVED,

REJECTED

score

number | null

Confidence score assigned by inference pipeline (0.0-1.0)

evidence

Evidence · object | null

Supporting evidence for inferred relationships

is_active

boolean

default:true

Whether this association is active/usable in the catalog

Response

Successful Response

Response model for SaaS associations.

integration_source_id

string<uuid>

required

The integration source this association belongs to

from_object_id

string<uuid>

required

The source SaaS object

to_object_id

string<uuid>

required

The target SaaS object

association_type_id

string

required

Platform-specific type identifier (e.g., HubSpot's numeric ID or Salesforce's API name)

association_label

string

required

Human-readable label (e.g., 'Contact to Company')

string<uuid>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

association_category

string

default:PLATFORM_DEFINED

Category of association (e.g., 'PLATFORM_DEFINED', 'USER_DEFINED', 'CUSTOM')

metadata_

Metadata · object | null

relationship_type

enum<string>

default:FOREIGN_KEY

Relationship type (platform vendor, inferred heuristic, manual override)

Available options:

FOREIGN_KEY,

INFERRED,

MANUAL

status

enum<string>

default:SUGGESTED

Review status for the relationship

Available options:

SUGGESTED,

APPROVED,

REJECTED

score

number | null

Confidence score assigned by inference pipeline (0.0-1.0)

evidence

Evidence · object | null

Supporting evidence for inferred relationships

is_active

boolean

default:true

Whether this association is active/usable in the catalog

Organizations

Members & Roles

User Identification

Integration Sources

Databases & Catalog

SaaS Catalog

Relationships & Context

Create Saas Association

Authorizations

Path Parameters

Query Parameters

Body

Response