Clarify

Supports:

  • ✅ Models
  • ✅ Model sync destination
  • ✅ Bulk sync source
  • ✅ Connection Proxy

Connection

Configuration

NameTypeDescriptionRequired
api_keystringAPI Keytrue
environmentstringEnvironment

Accepted values: production, development, custom
true
workspacestringWorkspacetrue

environment

When environment is custom
NameTypeDescriptionRequired
server_urlstringClarify API server URLtrue

Example

{
"name": "Clarify connection",
"type": "clarify",
"configuration": {
"api_key": "",
"environment": "",
"workspace": "acme"
}
}

Model Sync

Source

Configuration

NameTypeDescriptionRequired
objectstringObjecttrue

Example

{
...
"configuration": {
"object": "object"
}
}

Target

Clarify connections may be used as the destination in a model sync.

All targets

Configuration
NameTypeDescriptionRequired
invalid_relationshipsstringRecords with invalid relationship IDs

Accepted values: error, omit_values, omit_records
true
write_null_valuesbooleanCopy null valuesfalse
Example
{
...
"target": {
"configuration": {
"invalid_relationships": "",
"write_null_values": false
}
}
}

Bulk Sync

Source

Configuration

NameTypeDescriptionRequired
include_archivedbooleanInclude archived Clarify recordsfalse

Example

{
...
"source_configuration": {
"include_archived": false
}
}