curl --request POST \
--url https://api.stackone.com/v2/connector_profiles \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"connector_key": "<string>",
"authentication_config_key": "<string>",
"environment": "<string>",
"name": "<string>",
"active": false,
"is_default": true,
"version": "<string>",
"pinned_version": "<string>",
"owner": "<string>",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": [
"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"
]
},
"deel_webhook_employee_updated_direct": {
"enabled": false,
"webhook_ids": []
}
},
"sync_config": {},
"sync_event_subscriptions": {
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": [
"added",
"updated",
"removed"
]
}
]
},
"callback_domain": "auth.example.com"
}
'import requests
url = "https://api.stackone.com/v2/connector_profiles"
payload = {
"connector_key": "<string>",
"authentication_config_key": "<string>",
"environment": "<string>",
"name": "<string>",
"active": False,
"is_default": True,
"version": "<string>",
"pinned_version": "<string>",
"owner": "<string>",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {
"deel_webhook_employee_created_direct": {
"enabled": True,
"webhook_ids": ["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]
},
"deel_webhook_employee_updated_direct": {
"enabled": False,
"webhook_ids": []
}
},
"sync_config": {},
"sync_event_subscriptions": { "list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": ["added", "updated", "removed"]
}
] },
"callback_domain": "auth.example.com"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connector_key: '<string>',
authentication_config_key: '<string>',
environment: '<string>',
name: '<string>',
active: false,
is_default: true,
version: '<string>',
pinned_version: '<string>',
owner: '<string>',
setup_fields: {},
secrets: {},
action_config: {},
event_config: {
deel_webhook_employee_created_direct: {enabled: true, webhook_ids: ['c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13']},
deel_webhook_employee_updated_direct: {enabled: false, webhook_ids: []}
},
sync_config: {},
sync_event_subscriptions: {
list_employees: [{webhook_id: 'wh_2b8d1f9a', change_types: ['added', 'updated', 'removed']}]
},
callback_domain: 'auth.example.com'
})
};
fetch('https://api.stackone.com/v2/connector_profiles', 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.stackone.com/v2/connector_profiles",
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([
'connector_key' => '<string>',
'authentication_config_key' => '<string>',
'environment' => '<string>',
'name' => '<string>',
'active' => false,
'is_default' => true,
'version' => '<string>',
'pinned_version' => '<string>',
'owner' => '<string>',
'setup_fields' => [
],
'secrets' => [
],
'action_config' => [
],
'event_config' => [
'deel_webhook_employee_created_direct' => [
'enabled' => true,
'webhook_ids' => [
'c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13'
]
],
'deel_webhook_employee_updated_direct' => [
'enabled' => false,
'webhook_ids' => [
]
]
],
'sync_config' => [
],
'sync_event_subscriptions' => [
'list_employees' => [
[
'webhook_id' => 'wh_2b8d1f9a',
'change_types' => [
'added',
'updated',
'removed'
]
]
]
],
'callback_domain' => 'auth.example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.stackone.com/v2/connector_profiles"
payload := strings.NewReader("{\n \"connector_key\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": false,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {\n \"deel_webhook_employee_created_direct\": {\n \"enabled\": true,\n \"webhook_ids\": [\n \"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13\"\n ]\n },\n \"deel_webhook_employee_updated_direct\": {\n \"enabled\": false,\n \"webhook_ids\": []\n }\n },\n \"sync_config\": {},\n \"sync_event_subscriptions\": {\n \"list_employees\": [\n {\n \"webhook_id\": \"wh_2b8d1f9a\",\n \"change_types\": [\n \"added\",\n \"updated\",\n \"removed\"\n ]\n }\n ]\n },\n \"callback_domain\": \"auth.example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/v2/connector_profiles")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"connector_key\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": false,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {\n \"deel_webhook_employee_created_direct\": {\n \"enabled\": true,\n \"webhook_ids\": [\n \"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13\"\n ]\n },\n \"deel_webhook_employee_updated_direct\": {\n \"enabled\": false,\n \"webhook_ids\": []\n }\n },\n \"sync_config\": {},\n \"sync_event_subscriptions\": {\n \"list_employees\": [\n {\n \"webhook_id\": \"wh_2b8d1f9a\",\n \"change_types\": [\n \"added\",\n \"updated\",\n \"removed\"\n ]\n }\n ]\n },\n \"callback_domain\": \"auth.example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connector_profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connector_key\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": false,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {\n \"deel_webhook_employee_created_direct\": {\n \"enabled\": true,\n \"webhook_ids\": [\n \"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13\"\n ]\n },\n \"deel_webhook_employee_updated_direct\": {\n \"enabled\": false,\n \"webhook_ids\": []\n }\n },\n \"sync_config\": {},\n \"sync_event_subscriptions\": {\n \"list_employees\": [\n {\n \"webhook_id\": \"wh_2b8d1f9a\",\n \"change_types\": [\n \"added\",\n \"updated\",\n \"removed\"\n ]\n }\n ]\n },\n \"callback_domain\": \"auth.example.com\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"connector_key": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"categories": [
"<string>"
],
"release_stage": "<string>",
"authentication_config_label": "<string>"
},
"version": {
"resolved": "<string>",
"pinned": "<string>",
"owner": "<string>"
},
"accounts_count": 123,
"enabled_actions_count": 123,
"active": true,
"default": true,
"environment": "<string>",
"authentication_config_key": "<string>",
"callback_domain": "auth.example.com",
"callback_url": "https://auth.example.com/connect/oauth2/hubspot/callback",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": [
"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"
]
},
"deel_webhook_employee_updated_direct": {
"enabled": false,
"webhook_ids": []
}
},
"sync_config": {},
"sync_event_subscriptions": {
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": [
"added",
"updated",
"removed"
]
}
]
}
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Create a connector profile
Creates a connector profile and returns its full representation. enabled_actions_count cannot be expanded here. Read it back with a GET. Besides the authentication, the body can set which actions are enabled (action_config), which actions sync data (sync_config), which webhooks are notified of the changes those syncs find (sync_event_subscriptions) and which provider events are processed and delivered to webhooks (event_config).
curl --request POST \
--url https://api.stackone.com/v2/connector_profiles \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"connector_key": "<string>",
"authentication_config_key": "<string>",
"environment": "<string>",
"name": "<string>",
"active": false,
"is_default": true,
"version": "<string>",
"pinned_version": "<string>",
"owner": "<string>",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": [
"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"
]
},
"deel_webhook_employee_updated_direct": {
"enabled": false,
"webhook_ids": []
}
},
"sync_config": {},
"sync_event_subscriptions": {
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": [
"added",
"updated",
"removed"
]
}
]
},
"callback_domain": "auth.example.com"
}
'import requests
url = "https://api.stackone.com/v2/connector_profiles"
payload = {
"connector_key": "<string>",
"authentication_config_key": "<string>",
"environment": "<string>",
"name": "<string>",
"active": False,
"is_default": True,
"version": "<string>",
"pinned_version": "<string>",
"owner": "<string>",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {
"deel_webhook_employee_created_direct": {
"enabled": True,
"webhook_ids": ["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]
},
"deel_webhook_employee_updated_direct": {
"enabled": False,
"webhook_ids": []
}
},
"sync_config": {},
"sync_event_subscriptions": { "list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": ["added", "updated", "removed"]
}
] },
"callback_domain": "auth.example.com"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connector_key: '<string>',
authentication_config_key: '<string>',
environment: '<string>',
name: '<string>',
active: false,
is_default: true,
version: '<string>',
pinned_version: '<string>',
owner: '<string>',
setup_fields: {},
secrets: {},
action_config: {},
event_config: {
deel_webhook_employee_created_direct: {enabled: true, webhook_ids: ['c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13']},
deel_webhook_employee_updated_direct: {enabled: false, webhook_ids: []}
},
sync_config: {},
sync_event_subscriptions: {
list_employees: [{webhook_id: 'wh_2b8d1f9a', change_types: ['added', 'updated', 'removed']}]
},
callback_domain: 'auth.example.com'
})
};
fetch('https://api.stackone.com/v2/connector_profiles', 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.stackone.com/v2/connector_profiles",
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([
'connector_key' => '<string>',
'authentication_config_key' => '<string>',
'environment' => '<string>',
'name' => '<string>',
'active' => false,
'is_default' => true,
'version' => '<string>',
'pinned_version' => '<string>',
'owner' => '<string>',
'setup_fields' => [
],
'secrets' => [
],
'action_config' => [
],
'event_config' => [
'deel_webhook_employee_created_direct' => [
'enabled' => true,
'webhook_ids' => [
'c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13'
]
],
'deel_webhook_employee_updated_direct' => [
'enabled' => false,
'webhook_ids' => [
]
]
],
'sync_config' => [
],
'sync_event_subscriptions' => [
'list_employees' => [
[
'webhook_id' => 'wh_2b8d1f9a',
'change_types' => [
'added',
'updated',
'removed'
]
]
]
],
'callback_domain' => 'auth.example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.stackone.com/v2/connector_profiles"
payload := strings.NewReader("{\n \"connector_key\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": false,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {\n \"deel_webhook_employee_created_direct\": {\n \"enabled\": true,\n \"webhook_ids\": [\n \"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13\"\n ]\n },\n \"deel_webhook_employee_updated_direct\": {\n \"enabled\": false,\n \"webhook_ids\": []\n }\n },\n \"sync_config\": {},\n \"sync_event_subscriptions\": {\n \"list_employees\": [\n {\n \"webhook_id\": \"wh_2b8d1f9a\",\n \"change_types\": [\n \"added\",\n \"updated\",\n \"removed\"\n ]\n }\n ]\n },\n \"callback_domain\": \"auth.example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/v2/connector_profiles")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"connector_key\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": false,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {\n \"deel_webhook_employee_created_direct\": {\n \"enabled\": true,\n \"webhook_ids\": [\n \"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13\"\n ]\n },\n \"deel_webhook_employee_updated_direct\": {\n \"enabled\": false,\n \"webhook_ids\": []\n }\n },\n \"sync_config\": {},\n \"sync_event_subscriptions\": {\n \"list_employees\": [\n {\n \"webhook_id\": \"wh_2b8d1f9a\",\n \"change_types\": [\n \"added\",\n \"updated\",\n \"removed\"\n ]\n }\n ]\n },\n \"callback_domain\": \"auth.example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connector_profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connector_key\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"name\": \"<string>\",\n \"active\": false,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {\n \"deel_webhook_employee_created_direct\": {\n \"enabled\": true,\n \"webhook_ids\": [\n \"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13\"\n ]\n },\n \"deel_webhook_employee_updated_direct\": {\n \"enabled\": false,\n \"webhook_ids\": []\n }\n },\n \"sync_config\": {},\n \"sync_event_subscriptions\": {\n \"list_employees\": [\n {\n \"webhook_id\": \"wh_2b8d1f9a\",\n \"change_types\": [\n \"added\",\n \"updated\",\n \"removed\"\n ]\n }\n ]\n },\n \"callback_domain\": \"auth.example.com\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"connector_key": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"categories": [
"<string>"
],
"release_stage": "<string>",
"authentication_config_label": "<string>"
},
"version": {
"resolved": "<string>",
"pinned": "<string>",
"owner": "<string>"
},
"accounts_count": 123,
"enabled_actions_count": 123,
"active": true,
"default": true,
"environment": "<string>",
"authentication_config_key": "<string>",
"callback_domain": "auth.example.com",
"callback_url": "https://auth.example.com/connect/oauth2/hubspot/callback",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": [
"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"
]
},
"deel_webhook_employee_updated_direct": {
"enabled": false,
"webhook_ids": []
}
},
"sync_config": {},
"sync_event_subscriptions": {
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": [
"added",
"updated",
"removed"
]
}
]
}
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Query Parameters
A comma-separated list of additional fields to expand. Supported values: connector (the connector this profile configures), version (the connector version this profile resolves to), accounts_count (the number of accounts linked to this profile) and callback_url (the OAuth callback URL the provider app must allow for this profile). These are returned as null unless requested.
"connector,version"
Body
Whether this is the connector's default profile. When omitted, the first ACTIVE profile created for a connector becomes the default (a profile created disabled leaves the slot empty until one is enabled). An explicit true requires active to be true, otherwise the request is refused with connector_profile_disabled_cannot_be_default. When it replaces an existing default it requires permission to update that profile, and the previous default is demoted.
The events the profile processes and the webhooks they are delivered to, keyed by event action id: the id of an entry in event_actions from GET /v2/connectors/{id}?expand=actions (e.g. deel_webhook_employee_created_direct). Each entry sets whether the event action is enabled and, in webhook_ids, which webhooks receive its events. An event action left out is disabled. A webhook id that does not belong to the project fails the request with a 400. Keys are not checked against the connector, so an unknown event action id is stored but never matches an event.
Show child attributes
Show child attributes
{
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": ["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]
},
"deel_webhook_employee_updated_direct": { "enabled": false, "webhook_ids": [] }
}
The webhooks notified of the record changes each sync finds, keyed by the action id of a sync in sync_config. Each action must have a sync, enabled or not, and each webhook must belong to the project; otherwise the request is refused with sync_event_subscriptions_invalid or sync_event_subscription_webhook_not_found. A webhook may appear once per action. On create, each action must be in sync_config in the same request.
Show child attributes
Show child attributes
{
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": ["added", "updated", "removed"]
}
]
}
The hostname of one of the organization's active custom domains (e.g. auth.example.com) that the OAuth callback is served on, in place of StackOne's API host. null or omitted uses StackOne's default. Setting one requires the organization's plan to include custom OAuth domains, otherwise the request is refused with callback_domain_not_enabled_for_organization. It also requires a project or organization admin, otherwise the request is refused with callback_domain_admin_required. A hostname that is not an active custom domain of the organization is refused with callback_domain_not_available.
"auth.example.com"
Response
The connector profile was created.
How many of the connector version's actions this profile enables. For StackOne connectors only the actions in the release stages your organization can access are counted, so this can read lower than the number the profile actually enables; a connector your organization owns is counted in full. A profile that enables everything counts all of them; one naming individual actions counts only those the version still has. 0 when the profile enables nothing, and also whenever no catalogue can be resolved — an unreadable registry, or a connector whose own release stage your organization cannot access. Always present; null unless requested via ?expand=enabled_actions_count on a read endpoint, and always null on create.
The OAuth or OIDC callback URL to allow in the provider app for this profile. With a callback_domain in use it is always https://<callback_domain>/connect/oauth2/<connector_key>/callback. A callback_domain is in use while the organization's plan includes custom OAuth domains and the hostname is still one of its custom domains serving callbacks, which is an active domain or one pending deletion. Otherwise, or without one, it is the redirectUri set in the setup fields or declared by the connector, otherwise the standard callback path on StackOne's API host. null when the authentication configuration is neither OAuth 2.0 nor OIDC. Always present; null unless requested via ?expand=callback_url.
"https://auth.example.com/connect/oauth2/hubspot/callback"
The saved event action configuration and the webhooks subscribed to each event action, keyed by event action id. Set it with event_config on create or patch.
Show child attributes
Show child attributes
{
"deel_webhook_employee_created_direct": {
"enabled": true,
"webhook_ids": ["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]
},
"deel_webhook_employee_updated_direct": { "enabled": false, "webhook_ids": [] }
}
The webhooks notified of the record changes each sync finds, keyed by action id. Set it with sync_event_subscriptions on create or patch.
Show child attributes
Show child attributes
{
"list_employees": [
{
"webhook_id": "wh_2b8d1f9a",
"change_types": ["added", "updated", "removed"]
}
]
}
Was this page helpful?