# Fivetran

> Monitor and control your Fivetran data pipelines: list groups, destinations and connections, start syncs, pause or reschedule connections, read sync history and warnings, and manage webhooks.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/fivetran

## Actions

### Create group

Create a group. It has no destination until you set one up in Fivetran.

**Inputs**

- Name (`name`, text, required): The group's name, shown as the destination's name. Start with a letter or underscore, then use only letters, numbers and underscores.

**Outputs**

- `group` (object): The group

**Example output**

```json
{
  "group": {
    "created_at": "2026-10-01T09:00:00.000000Z",
    "id": "projected_sickle",
    "name": "Warehouse"
  }
}
```

### Create webhook

Have Fivetran send chosen events (syncs, connection changes, transformations) to an https address, for the whole account or one group.

**Inputs**

- Address (`url`, text, required): The https:// address Fivetran sends events to. Fivetran sends a test request to it when the webhook is on, and refuses it if that fails; turn 'Active' off to create it without the test.
- Events (`events`, list, required): Which events Fivetran sends to the address. One or more of: `sync_start` (A sync starts), `sync_end` (A sync ends), `transformation_start` (A transformation starts), `transformation_succeeded` (A transformation succeeds), `transformation_failed` (A transformation fails), `connection_successful` (A connection passes its setup tests), `connection_failure` (A connection fails its setup tests), `create_connector` (A connection is created), `pause_connector` (A connection is paused), `resume_connector` (A connection is resumed), and 5 more.
- Active (`active`, true/false): On sends events straight away and tests the address first. Off creates it paused. Defaults to on. Default: `true`.
- Signing secret (`secret`, text): A secret Fivetran signs each delivery with, so you can check it came from Fivetran. Leave empty for none.
- Only for this group (`group_id`, text): Send only this group's events. Leave empty for the whole account.

**Outputs**

- `webhook` (object): The webhook

**Example output**

```json
{
  "webhook": {
    "active": true,
    "created_at": "2026-10-01T09:00:00.000000Z",
    "created_by": "user_example",
    "events": [
      "sync_end"
    ],
    "group_id": "",
    "id": "webhook_example",
    "secret": "",
    "type": "account",
    "url": "https://example.com/fivetran"
  }
}
```

### Delete group

Delete a group. Fivetran refuses if it still has connections or a destination.

**Inputs**

- Group (`group_id`, text, required): The group (destination). Pick one, or give its id from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `group_id` (text): The group deleted

**Example output**

```json
{
  "deleted": true,
  "group_id": "projected_sickle"
}
```

### Delete webhook

Delete a webhook so Fivetran stops sending to it.

**Inputs**

- Webhook (`webhook_id`, text, required): The webhook. Pick one, or give its id from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `webhook_id` (text): The webhook deleted

**Example output**

```json
{
  "deleted": true,
  "webhook_id": "webhook_example"
}
```

### Get account info

Get the account, and the user, that the connected API key belongs to.

**Inputs**: None.

**Outputs**

- `account` (object): The account

**Example output**

```json
{
  "account": {
    "account_id": "account_example",
    "account_name": "Acme",
    "system_key_id": "",
    "user_id": "user_example"
  }
}
```

### Get connection

Get one connection: its source, schedule, sync state, warnings and setup test results.

**Inputs**

- Connection (`fivetran_connection_id`, text, required): The connection. Pick one, or give its id from an earlier step.

**Outputs**

- `connection` (object): The connection

**Example output**

```json
{
  "connection": {
    "connected_by": "user_example",
    "created_at": "2026-10-01T09:00:00.000000Z",
    "daily_sync_time": "",
    "data_delay_sensitivity": "NORMAL",
    "data_delay_threshold": 0,
    "failed_at": "",
    "group_id": "projected_sickle",
    "id": "iodize_cherish",
    "networking_method": "Directly",
    "pause_after_trial": false,
    "paused": false,
    "schedule_type": "auto",
    "schema": "sheets.orders",
    "service": "google_sheets",
    "service_version": 1,
    "setup_tests": [
      {
        "details": {},
        "message": "",
        "status": "PASSED",
        "title": "Validate login"
      }
    ],
    "status": {
      "is_historical_sync": false,
      "rescheduled_for": "",
      "schema_status": "ready",
      "setup_state": "connected",
      "sync_state": "scheduled",
      "tasks": [],
      "update_state": "on_schedule",
      "warnings": []
    },
    "succeeded_at": "2026-10-20T09:00:00.000000Z",
    "sync_frequency": 360
  }
}
```

### Get connection warnings

List the warnings on a connection's tables, such as a column Fivetran could not load.

**Inputs**

- Connection (`fivetran_connection_id`, text, required): The connection. Pick one, or give its id from an earlier step.
- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `connection_id` (text): The connection's id
- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one
- `warnings` (list): The warnings, grouped by table

**Example output**

```json
{
  "connection_id": "iodize_cherish",
  "count": 1,
  "next_cursor": "",
  "warnings": [
    {
      "schema": "orders",
      "table": "line_items",
      "warnings": [
        {
          "code": "unsupported_column",
          "created_at": "2026-10-20T09:00:00.000000Z",
          "error_message": "",
          "message": "A column was skipped."
        }
      ]
    }
  ]
}
```

### Get destination

Get one destination: its type, region, setup status and setup test results. A destination has the same id as its group.

**Inputs**

- Destination (`destination_id`, text, required): The destination, which has the same id as its group. Pick one, or give its id from an earlier step.

**Outputs**

- `destination` (object): The destination

**Example output**

```json
{
  "destination": {
    "daylight_saving_time_enabled": false,
    "group_id": "projected_sickle",
    "id": "projected_sickle",
    "networking_method": "Directly",
    "region": "GCP_US_EAST4",
    "service": "big_query",
    "setup_status": "CONNECTED",
    "setup_tests": [],
    "time_zone_offset": "0"
  }
}
```

### Get group

Get one group by its id.

**Inputs**

- Group (`group_id`, text, required): The group (destination). Pick one, or give its id from an earlier step.

**Outputs**

- `group` (object): The group

**Example output**

```json
{
  "group": {
    "created_at": "2026-10-01T09:00:00.000000Z",
    "id": "projected_sickle",
    "name": "Warehouse"
  }
}
```

### Get sync history

List a connection's recent syncs with when each started and ended and whether it completed, failed or was rescheduled.

**Inputs**

- Connection (`fivetran_connection_id`, text, required): The connection. Pick one, or give its id from an earlier step.
- From (`start_time`, date and time): Only syncs from this time on. Leave empty for the most recent.
- Until (`end_time`, date and time): Only syncs up to this time. Leave empty for now.
- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `connection_id` (text): The connection's id
- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one
- `syncs` (list): The syncs, newest first

**Example output**

```json
{
  "connection_id": "iodize_cherish",
  "count": 1,
  "next_cursor": "",
  "syncs": [
    {
      "end": "2026-10-20T09:03:00.000Z",
      "reason": "",
      "stages": {},
      "start": "2026-10-20T09:00:00.000Z",
      "status": "COMPLETED",
      "sync_id": "sync_example"
    }
  ]
}
```

### Get user

Get one user: their name, email, role and last sign-in.

**Inputs**

- User (`fivetran_user_id`, text, required): The user. Pick one, or give their id.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "user": {
    "active": true,
    "created_at": "2026-10-01T09:00:00.000000Z",
    "email": "jo@example.com",
    "family_name": "Bloggs",
    "given_name": "Jo",
    "has_api_key": true,
    "id": "user_example",
    "invited": false,
    "logged_in_at": "2026-10-20T09:00:00.000000Z",
    "phone": "",
    "picture": "",
    "role": "Account Administrator",
    "user_type": "REGULAR_USER",
    "verified": true
  }
}
```

### Get webhook

Get one webhook with its address, events and state.

**Inputs**

- Webhook (`webhook_id`, text, required): The webhook. Pick one, or give its id from an earlier step.

**Outputs**

- `webhook` (object): The webhook

**Example output**

```json
{
  "webhook": {
    "active": true,
    "created_at": "2026-10-01T09:00:00.000000Z",
    "created_by": "user_example",
    "events": [
      "sync_end"
    ],
    "group_id": "",
    "id": "webhook_example",
    "secret": "",
    "type": "account",
    "url": "https://example.com/fivetran"
  }
}
```

### List connections

List the connections (data pipelines from a source into a destination), with their sync state and when they last succeeded or failed.

**Inputs**

- Group (`group_id`, text): Only connections in this group (destination).
- Schema name (`schema`, text): Only the connection with exactly this schema name.
- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `connections` (list): The connections
- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one

**Example output**

```json
{
  "connections": [
    {
      "connected_by": "user_example",
      "created_at": "2026-10-01T09:00:00.000000Z",
      "daily_sync_time": "",
      "data_delay_sensitivity": "NORMAL",
      "data_delay_threshold": 0,
      "failed_at": "",
      "group_id": "projected_sickle",
      "id": "iodize_cherish",
      "networking_method": "Directly",
      "pause_after_trial": false,
      "paused": false,
      "schedule_type": "auto",
      "schema": "sheets.orders",
      "service": "google_sheets",
      "service_version": 1,
      "setup_tests": [
        {
          "details": {},
          "message": "",
          "status": "PASSED",
          "title": "Validate login"
        }
      ],
      "status": {
        "is_historical_sync": false,
        "rescheduled_for": "",
        "schema_status": "ready",
        "setup_state": "connected",
        "sync_state": "scheduled",
        "tasks": [],
        "update_state": "on_schedule",
        "warnings": []
      },
      "succeeded_at": "2026-10-20T09:00:00.000000Z",
      "sync_frequency": 360
    }
  ],
  "count": 1,
  "next_cursor": ""
}
```

### List destinations

List the destinations (the warehouses and databases data is loaded into) in the account.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many on this page
- `destinations` (list): The destinations
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one

**Example output**

```json
{
  "count": 1,
  "destinations": [
    {
      "daylight_saving_time_enabled": false,
      "group_id": "projected_sickle",
      "id": "projected_sickle",
      "networking_method": "Directly",
      "region": "GCP_US_EAST4",
      "service": "big_query",
      "setup_status": "CONNECTED",
      "setup_tests": [],
      "time_zone_offset": "0"
    }
  ],
  "next_cursor": ""
}
```

### List groups

List the groups in the account. A group holds one destination and the connections that load into it.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many on this page
- `groups` (list): The groups
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one

**Example output**

```json
{
  "count": 1,
  "groups": [
    {
      "created_at": "2026-10-01T09:00:00.000000Z",
      "id": "projected_sickle",
      "name": "Warehouse"
    }
  ],
  "next_cursor": ""
}
```

### List roles

List the roles users and teams can be given.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one
- `roles` (list): The roles

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "roles": [
    {
      "description": "Full access",
      "is_custom": false,
      "is_deprecated": false,
      "name": "Account Administrator",
      "replacement_role_name": "",
      "scope": [
        "ACCOUNT"
      ]
    }
  ]
}
```

### List source types

List the kinds of source Fivetran can load from, such as Salesforce or Postgres, with their status and docs.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `connector_types` (list): The source types
- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one

**Example output**

```json
{
  "connector_types": [
    {
      "connector_class": "standard",
      "description": "Load data from Google Sheets.",
      "icon_url": "https://fivetran.com/integrations/google_sheets.svg",
      "id": "google_sheets",
      "link_to_docs": "https://fivetran.com/docs/connectors/files/google-sheets",
      "name": "Google Sheets",
      "service_status": "general_availability",
      "supported_features": [
        {
          "id": "RE_SYNC",
          "notes": ""
        }
      ],
      "supports_schema_reload": true,
      "type": "Productivity"
    }
  ],
  "count": 1,
  "next_cursor": ""
}
```

### List teams

List the teams in the account with their roles.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one
- `teams` (list): The teams

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "teams": [
    {
      "description": "",
      "id": "team_example",
      "name": "Data team",
      "role": "Account Reviewer"
    }
  ]
}
```

### List users

List the users in the account with their roles.

**Inputs**

- Enabled or disabled (`active`, text): Only enabled or only disabled users. Leave empty for both. One of: `true` (Enabled users only), `false` (Disabled users only).
- Kind of user (`user_type`, text): Only people, or only service accounts. Leave empty for both. One of: `REGULAR_USER` (People who sign in), `SERVICE_ACCOUNT` (Service accounts (API only)).
- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "users": [
    {
      "active": true,
      "created_at": "2026-10-01T09:00:00.000000Z",
      "email": "jo@example.com",
      "family_name": "Bloggs",
      "given_name": "Jo",
      "has_api_key": true,
      "id": "user_example",
      "invited": false,
      "logged_in_at": "2026-10-20T09:00:00.000000Z",
      "phone": "",
      "picture": "",
      "role": "Account Administrator",
      "user_type": "REGULAR_USER",
      "verified": true
    }
  ]
}
```

### List users in a group

List the users who have access to a group.

**Inputs**

- Group (`group_id`, text, required): The group (destination). Pick one, or give its id from an earlier step.
- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many on this page
- `group_id` (text): The group's id
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one
- `users` (list): The group's users

**Example output**

```json
{
  "count": 1,
  "group_id": "projected_sickle",
  "next_cursor": "",
  "users": [
    {
      "active": true,
      "created_at": "2026-10-01T09:00:00.000000Z",
      "email": "jo@example.com",
      "family_name": "Bloggs",
      "given_name": "Jo",
      "has_api_key": true,
      "id": "user_example",
      "invited": false,
      "logged_in_at": "2026-10-20T09:00:00.000000Z",
      "phone": "",
      "picture": "",
      "role": "Account Administrator",
      "user_type": "REGULAR_USER",
      "verified": true
    }
  ]
}
```

### List webhooks

List the account's webhooks with their addresses, events and whether they are on.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 1000. Fivetran's default is 100. From 1 to 1000.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many on this page
- `next_cursor` (text): Pass as 'cursor' for the next page; empty on the last one
- `webhooks` (list): The webhooks

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "webhooks": [
    {
      "active": true,
      "created_at": "2026-10-01T09:00:00.000000Z",
      "created_by": "user_example",
      "events": [
        "sync_end"
      ],
      "group_id": "",
      "id": "webhook_example",
      "secret": "",
      "type": "account",
      "url": "https://example.com/fivetran"
    }
  ]
}
```

### Pause, resume or reschedule connection

Pause a connection, let it run again, or change how often it syncs. Only the fields given change.

**Inputs**

- Connection (`fivetran_connection_id`, text, required): The connection. Pick one, or give its id from an earlier step.
- Status (`status`, text): Pause the connection or let it run. Leave empty to keep it. One of: `running` (Running (syncs on its schedule)), `paused` (Paused (no syncs)).
- Sync frequency (`sync_frequency`, text): How often it syncs. Leave empty to keep it. One of: `1` (Every minute), `5` (Every 5 minutes), `15` (Every 15 minutes), `30` (Every 30 minutes), `60` (Every hour), `120` (Every 2 hours), `180` (Every 3 hours), `360` (Every 6 hours), `480` (Every 8 hours), `720` (Every 12 hours), `1440` (Every 24 hours).

**Outputs**

- `connection` (object): The connection

**Example output**

```json
{
  "connection": {
    "connected_by": "user_example",
    "created_at": "2026-10-01T09:00:00.000000Z",
    "daily_sync_time": "",
    "data_delay_sensitivity": "NORMAL",
    "data_delay_threshold": 0,
    "failed_at": "",
    "group_id": "projected_sickle",
    "id": "iodize_cherish",
    "networking_method": "Directly",
    "pause_after_trial": false,
    "paused": true,
    "schedule_type": "auto",
    "schema": "sheets.orders",
    "service": "google_sheets",
    "service_version": 1,
    "setup_tests": [
      {
        "details": {},
        "message": "",
        "status": "PASSED",
        "title": "Validate login"
      }
    ],
    "status": {
      "is_historical_sync": false,
      "rescheduled_for": "",
      "schema_status": "ready",
      "setup_state": "connected",
      "sync_state": "scheduled",
      "tasks": [],
      "update_state": "on_schedule",
      "warnings": []
    },
    "succeeded_at": "2026-10-20T09:00:00.000000Z",
    "sync_frequency": 360
  }
}
```

### Rename group

Change a group's name.

**Inputs**

- Group (`group_id`, text, required): The group (destination). Pick one, or give its id from an earlier step.
- Name (`name`, text, required): The group's name, shown as the destination's name. Start with a letter or underscore, then use only letters, numbers and underscores.

**Outputs**

- `group` (object): The group

**Example output**

```json
{
  "group": {
    "created_at": "2026-10-01T09:00:00.000000Z",
    "id": "projected_sickle",
    "name": "Warehouse 2"
  }
}
```

### Run connection setup tests

Check that Fivetran can still reach the source with the connection's saved credentials. Returns each test's result.

**Inputs**

- Connection (`fivetran_connection_id`, text, required): The connection. Pick one, or give its id from an earlier step.

**Outputs**

- `connection` (object): The connection

**Example output**

```json
{
  "connection": {
    "connected_by": "user_example",
    "created_at": "2026-10-01T09:00:00.000000Z",
    "daily_sync_time": "",
    "data_delay_sensitivity": "NORMAL",
    "data_delay_threshold": 0,
    "failed_at": "",
    "group_id": "projected_sickle",
    "id": "iodize_cherish",
    "networking_method": "Directly",
    "pause_after_trial": false,
    "paused": false,
    "schedule_type": "auto",
    "schema": "sheets.orders",
    "service": "google_sheets",
    "service_version": 1,
    "setup_tests": [
      {
        "details": {},
        "message": "",
        "status": "PASSED",
        "title": "Validate login"
      }
    ],
    "status": {
      "is_historical_sync": false,
      "rescheduled_for": "",
      "schema_status": "ready",
      "setup_state": "connected",
      "sync_state": "scheduled",
      "tasks": [],
      "update_state": "on_schedule",
      "warnings": []
    },
    "succeeded_at": "2026-10-20T09:00:00.000000Z",
    "sync_frequency": 360
  }
}
```

### Start sync

Start a sync now instead of waiting for the schedule. Fivetran answers whether it started; it does not wait for the sync to finish.

**Inputs**

- Connection (`fivetran_connection_id`, text, required): The connection. Pick one, or give its id from an earlier step.
- Stop a running sync first (`force`, true/false): If a sync is already running, stop it and start a new one. Off by default. Default: `false`.

**Outputs**

- `connection_id` (text): The connection's id
- `result` (text): STARTED, ALREADY_RUNNING, PAUSED, INCOMPLETE or NOT_STARTED

**Example output**

```json
{
  "connection_id": "iodize_cherish",
  "result": "STARTED"
}
```
