> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/census.md).

# Census

Connect to Census, now also sold as Fivetran Activations, to drive warehouse-to-app data syncs from your AI workflows: start a sync on demand, poll a run to completion with its record counts, list the workspace's syncs and one sync's run history, and create a new sync from a warehouse table or model into a destination object.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector                  | Authentication    |
| -------------------------- | ----------------- |
| Census (Workspace API Key) | Workspace API Key |

#### Census (Workspace API Key)

Connect to Census, now also sold as Fivetran Activations, to run and monitor warehouse-to-app syncs. Authenticates with ONE workspace's API key, so this connection reaches exactly one Census workspace: add another connection for each further workspace. An organization personal access token will not work here, because it authenticates only Census's Organization APIs.

**Set up in Census**

1. Prepare the Census account or service that the workflow will access. Grant access to the required resources and operations.
2. **Workspace API Key:** The API key of ONE Census workspace. Open that workspace in Census, then find the API Access section of its workspace settings. This must be a workspace API key: an organization personal access token authenticates only Census's Organization APIs and is rejected on syncs and sync runs. A workspace key reaches only its own workspace, so add one connection per workspace.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Census (Workspace API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field     | Required                 | What to enter                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ----------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace API Key | Yes                      | The API key of ONE Census workspace. Open that workspace in Census, then find the API Access section of its workspace settings. This must be a workspace API key: an organization personal access token authenticates only Census's Organization APIs and is rejected on syncs and sync runs. A workspace key reaches only its own workspace, so add one connection per workspace. [Provider instructions](https://fivetran.com/docs/activations/rest-api/api-reference/introduction/authorization). |
| Region            | Optional / as applicable | The region hosting this Census workspace: 'us' for app.getcensus.com or 'eu' for app-eu.getcensus.com. Census documents no hostname for its AU region, so AU workspaces are not supported.                                                                                                                                                                                                                                                                                                           |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Census** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Trigger Sync Run

Start a Census sync now and get back the run id to track it.

**Inputs**

| Field                                | Type            | Required | Description                                                                                                             |
| ------------------------------------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| Sync                                 | select (string) | Yes      | The sync to run now. Options load from the selected connection.                                                         |
| Full re-sync                         | boolean         | No       | Re-send every row instead of only the rows that changed. Default: false.                                                |
| Skip if a run is already in progress | boolean         | No       | When a run is already queued or working, report that run instead of starting one that Census would skip. Default: true. |

**Outputs**

| Field           | Type    | Description                                                         |
| --------------- | ------- | ------------------------------------------------------------------- |
| Run ID          | string  | Id of the run to track.                                             |
| Sync ID         | string  | The sync that was triggered.                                        |
| Started         | boolean | True when this call started a new run.                              |
| Already running | boolean | True when a run was already in progress and no new run was started. |
| Status          | string  | Status of the returned run, when known.                             |

#### Get Sync Run Status

Check whether a sync run finished, failed, or is still going, with its record counts.

**Inputs**

| Field  | Type   | Required | Description       |
| ------ | ------ | -------- | ----------------- |
| Run ID | string | Yes      | The run to check. |

**Outputs**

| Field             | Type    | Description                                                  |
| ----------------- | ------- | ------------------------------------------------------------ |
| Run ID            | string  | The run that was checked.                                    |
| Sync ID           | string  | The sync this run belongs to.                                |
| Status            | string  | Run status: queued, working, completed, failed or skipped.   |
| Finished          | boolean | True once the run has stopped, whether it succeeded or not.  |
| Succeeded         | boolean | True only when the run completed successfully.               |
| Canceled          | boolean | True when the run was canceled.                              |
| Full sync         | boolean | True when this run re-sent every row.                        |
| Current step      | string  | What the run is doing right now.                             |
| Error code        | string  | Census's code for why the run failed.                        |
| Error message     | string  | Why the run failed.                                          |
| Error detail      | string  | The destination's own words for why it rejected the records. |
| Records processed | integer | How many records the run sent.                               |
| Records updated   | integer | How many records changed in the destination.                 |
| Records failed    | integer | How many records the destination rejected.                   |
| Records invalid   | integer | How many records Census judged invalid before sending.       |
| Source records    | integer | How many records the source held for this run.               |
| Created at        | string  | When the run was created.                                    |
| Completed at      | string  | When the run finished.                                       |

#### List Syncs

List the syncs configured in this Census workspace so you can pick one.

**Inputs**

| Field       | Type            | Required | Description                                                                                                          |
| ----------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| Max results | integer         | No       | How many syncs to fetch, rounded up to whole pages of 25. Minimum: 1. Maximum: 200. Default: 25.                     |
| Order       | select (string) | No       | Newest first (desc) or oldest first (asc). Available values: Newest first (desc), Oldest first (asc). Default: desc. |
| Page        | integer         | No       | Continue a previous listing from where it stopped.                                                                   |

**Outputs**

| Field       | Type          | Description                                  |
| ----------- | ------------- | -------------------------------------------- |
| Syncs       | object\_array | The syncs in this workspace.                 |
| Next page   | integer       | Pass back as Page to fetch the next batch.   |
| Total syncs | integer       | How many syncs the workspace holds in total. |

#### List Sync Runs

Show the recent run history for one sync, newest first.

**Inputs**

| Field       | Type            | Required | Description                                                                                                          |
| ----------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| Sync        | select (string) | Yes      | The sync whose run history you want. Options load from the selected connection.                                      |
| Max results | integer         | No       | How many runs to fetch, rounded up to whole pages of 25. Minimum: 1. Maximum: 200. Default: 25.                      |
| Order       | select (string) | No       | Newest first (desc) or oldest first (asc). Available values: Newest first (desc), Oldest first (asc). Default: desc. |
| Page        | integer         | No       | Continue a previous listing from where it stopped.                                                                   |

**Outputs**

| Field      | Type          | Description                                |
| ---------- | ------------- | ------------------------------------------ |
| Runs       | object\_array | The matching sync runs.                    |
| Next page  | integer       | Pass back as Page to fetch the next batch. |
| Total runs | integer       | How many runs this sync has in total.      |

#### Create Sync

Create a new sync from a warehouse table or model into a destination object.

**Inputs**

| Field                              | Type            | Required | Description                                                                                                                                                                                          |
| ---------------------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Operation                          | select (string) | Yes      | How Census should write rows into the destination. Available values: Upsert, Update, Insert, Append, Mirror. Default: upsert.                                                                        |
| Source                             | select (string) | Yes      | The warehouse or database Census reads from. Options load from the selected connection.                                                                                                              |
| Source type                        | select (string) | Yes      | Read a warehouse table, or a Census model. Available values: Warehouse table, Census model. Default: table.                                                                                          |
| Table                              | select (string) | No       | The table to read. Picking it from the list also sets its schema and database. Options load from the selected connection.                                                                            |
| Schema                             | string          | No       | Schema the table lives in, for example PUBLIC. Leave empty when you picked the table from the list.                                                                                                  |
| Database                           | string          | No       | Database or catalog the table lives in, for example ANALYTICS. Leave empty when you picked the table from the list.                                                                                  |
| Model                              | string          | No       | Name of the Census model to read; required for a model source.                                                                                                                                       |
| Destination                        | select (string) | Yes      | The app Census writes into. Options load from the selected connection.                                                                                                                               |
| Destination object                 | select (string) | Yes      | Which object in the destination app to write, for example Account or Contact. Options load from the selected connection.                                                                             |
| Source column                      | string          | Yes      | Column in the table or model to send; by default it identifies each record.                                                                                                                          |
| Destination field                  | select (string) | Yes      | Field the source column lands in, and by default the key Census matches records on. Options load from the selected connection.                                                                       |
| This mapping identifies the record | boolean         | No       | Use this field as the sync key that tells new records from existing ones. Default: true.                                                                                                             |
| Name                               | string          | No       | A name for the sync, shown in Census.                                                                                                                                                                |
| Schedule                           | select (string) | No       | How often Census should run the sync on its own. Defaults to never, so it only runs when you tell it to. Available values: Never, Continuous, Quarter hourly, Hourly, Daily, Weekly. Default: never. |
| Show advanced options              | boolean         | No       | Reveal extra field mappings, creating the sync paused, and the validate-only dry run. Default: false.                                                                                                |
| More field mappings                | string          | No       | Extra column-to-field pairs, comma separated, as source\_column:destination\_field.                                                                                                                  |
| Create paused                      | boolean         | No       | Create the sync without letting it run yet. Default: false.                                                                                                                                          |
| Validate only                      | boolean         | No       | Check the configuration without creating the sync. Default: false.                                                                                                                                   |

**Outputs**

| Field          | Type    | Description                            |
| -------------- | ------- | -------------------------------------- |
| Sync ID        | string  | Id of the new sync.                    |
| Created        | boolean | True when a sync was actually created. |
| Validated only | boolean | True when this was a dry run.          |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/census.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
