Introduction
Organization APIs
curl --request PUT \
--url https://app.getcensus.com/api/v1/connectors/{service_name}/publish_to_organization \
--header 'Authorization: Bearer <token>'{
"status": "published_to_organization",
"data": {
"service_name": "braze",
"documentation_slug": "braze",
"label": "Braze",
"auth_method": "credentials",
"creatable_via_api": true,
"creatable_via_connect_link": true,
"source_creatable_via_connect_link": true,
"configuration_fields": {
"fields": [
{
"id": "instance_url",
"rules": "required",
"label": "Endpoint URL",
"type": "string",
"placholder": "https://rest.iad-01.braze.com",
"matches": "^(?:(?=.*rest)https:\\\\/\\\\/rest|(?!.*rest)(https:\\\\/\\\\/)?sdk)\\\\.(iad|fra)-\\\\d\\\\d\\\\.braze\\\\.(com|eu)",
"is_password_type_field": false,
"possible_values": [
"<string>"
],
"read_more": "https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations",
"hint": "You can find your API key in the YourService UI under Settings > Integrations > API Key\n",
"show": true,
"conditionally_required": {
"if": {
"auth_type": {
"eq": "system_user"
}
}
},
"input_type": "textbox"
}
]
}
}
}Publish destination type to organization
Publish a destination type to the organization. This will make the destination type available to all workspaces in the organization. You must be an owner of the destination type and it must not be already published. See Scoped Destinations for more details. For information on publishing to all Census customers, see Partner Destinations.
curl --request PUT \
--url https://app.getcensus.com/api/v1/connectors/{service_name}/publish_to_organization \
--header 'Authorization: Bearer <token>'{
"status": "published_to_organization",
"data": {
"service_name": "braze",
"documentation_slug": "braze",
"label": "Braze",
"auth_method": "credentials",
"creatable_via_api": true,
"creatable_via_connect_link": true,
"source_creatable_via_connect_link": true,
"configuration_fields": {
"fields": [
{
"id": "instance_url",
"rules": "required",
"label": "Endpoint URL",
"type": "string",
"placholder": "https://rest.iad-01.braze.com",
"matches": "^(?:(?=.*rest)https:\\\\/\\\\/rest|(?!.*rest)(https:\\\\/\\\\/)?sdk)\\\\.(iad|fra)-\\\\d\\\\d\\\\.braze\\\\.(com|eu)",
"is_password_type_field": false,
"possible_values": [
"<string>"
],
"read_more": "https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations",
"hint": "You can find your API key in the YourService UI under Settings > Integrations > API Key\n",
"show": true,
"conditionally_required": {
"if": {
"auth_type": {
"eq": "system_user"
}
}
},
"input_type": "textbox"
}
]
}
}
}Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Path Parameters
Name of the destination type to publish
Response
Connector published successfully
Outcome of the operation.
published_to_organization, not_found, error "published_to_organization"
Show child attributes
Show child attributes
The full name for this destination type. This is used to identify the destination type in the API.
"braze"
The path to this destination type's Census documentation, ie https://docs.getcensus.com/destinations/available-destinations/{documentation_slug}.
"braze"
The name of this destination type.
"Braze"
How to authorize a destination of this type of destination type.
credentials, oauth, other Whether you can create connections of this type using the Create Destination API. If you'd like to create a destination via API that isn't marked as creatable_via_api, check out the docs for our Destination Connect Links if the destination is marked as creatable_via_connect_link, or reach out to us.
Whether you can create connections of this type using Census Connect Links. If you'd like to create a destination via Connect Link that isn't currently supported, please reach out to us.
Whether you can create source connections of this type using Census Source Connect Links, for building SaaS Datasets on top of.
Top level object containing a list of fields needed to create a connection of this type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The name of this configuration field. This is used to identify the credential in the API to create a connection of this type.
"instance_url"
Validations around this field, ie 'required'
"required"
A user facing name for this field
"Endpoint URL"
The type of this field
string, integer, boolean "string"
A placeholder for this field, usually an example of its value
"https://rest.iad-01.braze.com"
A regex string the value must match
"^(?:(?=.*rest)https:\\\\/\\\\/rest|(?!.*rest)(https:\\\\/\\\\/)?sdk)\\\\.(iad|fra)-\\\\d\\\\d\\\\.braze\\\\.(com|eu)"
If this is a credential field that contains sensitive data
false
If this credential accepts a finite list of values, what those values are
A link to read more about this destination, usually linking to the Census docs.
"https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations"
A hint to the user about this field, such as instructions for how to find the value
"You can find your API key in the YourService UI under Settings > Integrations > API Key\n"
Controls the visibility of this field in the UI based on the values of other fields. This is commonly used for source and destination types that support multiple authentication methods.
When show is true, the field is always visible. When show is an object, it contains conditional logic using if or unless:
if: The field is shown when the specified condition is metunless: The field is hidden when the specified condition is met
The eq value can be either a boolean or a string, depending on the field being referenced.
For example, in Snowflake which supports both password and keypair authentication:
- The
passwordfield has"show": {"unless": {"use_keypair": {"eq": true}}}- shown only when keypair auth is disabled (boolean) - The
private_key_pkcs8field has"show": {"if": {"use_keypair": {"eq": true}}}- shown only when keypair auth is enabled (boolean)
In Facebook Ads with string-based auth type:
"show": {"if": {"auth_type": {"eq": "oauth"}}}- shown only when auth_type equals "oauth" (string)
true
Specifies conditions under which this field becomes required, even if it's not listed in the rules array as required. This is used when a field's requirement status depends on the values of other fields.
When conditionally_required is null, the field's requirement is determined solely by the rules array. When it's an object, it contains conditional logic using if or unless:
if: The field becomes required when the specified condition is metunless: The field is not required when the specified condition is met
The eq value can be either a boolean or a string, depending on the field being referenced.
For example, in Facebook Ads, auth_type controls which authentication flow is used:
- When
auth_typeis"oauth", theoauth_tokenfield is conditionally required:{"if": {"auth_type": {"eq": "oauth"}}}(string) - When
auth_typeis"system_user", thesystem_user_tokenfield is conditionally required:{"if": {"auth_type": {"eq": "system_user"}}}(string)
A field could also use unless with a boolean, such as: {"unless": {"use_keypair": {"eq": true}}} - required unless keypair auth is enabled
Show child attributes
Show child attributes
Condition object specifying when this field becomes required. The field is required when the condition evaluates to true.
Condition object specifying when this field is not required. The field is not required when the condition evaluates to true.
{
"if": { "auth_type": { "eq": "system_user" } }
}Was this page helpful?