Introduction
Organization APIs
- Users
- Invitations
- Workspaces
Workspace APIs
- Syncs
- Sync Management Links
- Sync Runs
- Destination Types
- Destinations
- Destination Connect Links
- Source Types
- Sources
- Source Connect Links
- Segment Management Links
Create a new destination type
Create a new destination type for your given workspace. By default the destination type is created and scoped just to your workspace and not visible to other workspaces or orgs. See Scoped Destinations and Partner Destinations for more information on how to create destination types that are visible to other workspaces or orgs.
curl --request POST \
--url https://app.getcensus.com/api/v1/connectors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"connector": {
"service_name": "braze",
"label": "Braze",
"icon_url": "https://example.com/icon.png",
"configuration_definition": {
"your_field_id": {
"id": "my_id",
"label": "Api Token",
"type": "string",
"default": "<string>",
"user_editable": true,
"secret": false,
"required": false,
"placeholder": "Enter your API token"
}
},
"data": {
"url": "https://example.com",
"headers": {
"Authorization": "Bearer {{ api_token }}"
}
}
}
}'{
"status": "created",
"data": {
"documentation_slug": "braze",
"label": "Braze",
"service_name": "braze",
"auth_method": "credentials",
"creatable_via_api": true,
"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",
"input_type": "textbox"
}
]
}
}
}Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Body
The full name for this destination type. This is used to identify the destination type in the API.
The name of this destination type.
The URL to the icon for this destination type. Must be <100kb and must be image/png.
The configuration fields required to create a destination of this destination type.
User-friendly label for the input.
The type of this field.
string, boolean, integer, float Whether the user can edit this field.
Unique id for this field in the configuration.
The default value for this field.
Whether the field is a secret. This ensures the frontend doesn't render secrets in plaintext.
Whether the field is required to set up a connection.
Placeholder text for the input.
Response
Outcome of the operation.
success, updated, created, not_found, error The full name for this destination type. This is used to identify the destination type in the API.
The path to this destination type's Census documentation, ie https://docs.getcensus.com/destinations/available-destinations/{documentation_slug}.
The name of this destination type.
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.
Top level object containing a list of fields needed to create a connection of this type.
The name of this configuration field. This is used to identify the credential in the API to create a connection of this type.
Validations around this field, ie 'required'
A user facing name for this field
The type of this field
string, integer, boolean A placeholder for this field, usually an example of its value
A regex string the value must match
If this is a credential field that contains sensitive data
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.
A hint to the user about this field, such as instructions for how to find the value
Was this page helpful?
curl --request POST \
--url https://app.getcensus.com/api/v1/connectors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"connector": {
"service_name": "braze",
"label": "Braze",
"icon_url": "https://example.com/icon.png",
"configuration_definition": {
"your_field_id": {
"id": "my_id",
"label": "Api Token",
"type": "string",
"default": "<string>",
"user_editable": true,
"secret": false,
"required": false,
"placeholder": "Enter your API token"
}
},
"data": {
"url": "https://example.com",
"headers": {
"Authorization": "Bearer {{ api_token }}"
}
}
}
}'{
"status": "created",
"data": {
"documentation_slug": "braze",
"label": "Braze",
"service_name": "braze",
"auth_method": "credentials",
"creatable_via_api": true,
"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",
"input_type": "textbox"
}
]
}
}
}