Import from Splash

The “Import from Splash” script template (template ID 326557) imports data from the Splash API.

Parameters

• Splash API Credential (required): The Splash API Client ID (username) and Client Secret (password). To get them, request API access from your Splash Customer Success Manager.
• Splash User Credential (required): The username and password of a Splash user login. The import runs as this user, so it only sees the data this user can see. We recommend a dedicated integration user rather than a staff member's personal login.
• Splash Object (required): The Splash object to import.
  • Contacts
    • This option uses the GET Get List of Contacts endpoint.
  • Events
    • This option uses the GET All Events endpoint.
  • Group Contacts (Event Guests)
    • This option uses the GET All Group Contacts endpoint.
• Days (optional): Only relevant to the "Events" and "Group Contacts (Event Guests)" Splash objects; ignored for other objects. The number of days (as an integer) of records to import based on when each record was last modified. If not specified, all records will be imported. If specified on its own, only records last modified on or after N days ago (UTC) will be imported. This parameter can optionally be used in conjunction with "Start Date" or "End Date".
• Start Date (optional): Only relevant to the "Events" and "Group Contacts (Event Guests)" Splash objects; ignored for other objects. If specified, only import records last modified on or after the given date (UTC). Format: YYYY-MM-DD. This parameter can optionally be used in conjunction with "Days" or "End Date".
• End Date (optional): Only relevant to the "Events" and "Group Contacts (Event Guests)" Splash objects; ignored for other objects. If specified, only import records last modified on or before the given date (UTC). Format: YYYY-MM-DD. This parameter can optionally be used in conjunction with "Days" or "Start Date".
• Database (required): The Civis Platform database to which to write records.
• Database Credential (required): A valid database credential for the Civis Platform database. To use the credential associated with the logged-in user, choose from the dropdown the credential that has this user’s Civis Platform username.
• Schema and Tablename (required): The schema and table name you would like to import the data into, e.g., schema.table.
• Column Data Type Overrides (optional): A mapping from column names to data types to use instead of the data types from the data source. Each line should be in the form of "column_name: DATA_TYPE" (without quotes), e.g., "foo_bar: VARCHAR". Only provide an entry for columns for which you want to override the data type; do not provide entries for columns that should use the default data type from the data source. This parameter is useful for data type issues that would otherwise cause the import to fail, e.g., use "foobar: VARCHAR" if the data source says "foobar" should be a numeric type but it actually contains non-numeric values.
• Existing Table Exists (optional): The action to take if a table with the requested name already exists (default: Fail). Options are:
  • Append: Records will be appended to the existing table
  • Fail: The sync job fails if the table exists
  • Drop: Removes the entire table including column information.
  • Truncate: Records on the table will be wiped out while maintaining the current columns.
  • Upsert: The "upsert" option is only supported for the "Events" (primary key: id, last modified key: modified_at) and "Group Contacts" (primary key: id, last modified key: modified) Splash objects. For incremental syncs in an automated pipeline, combine this “upsert” option with the “days” / “start date” / “end date” parameters above, e.g., “existing table rows = upsert” and “days = 7” if your pipeline is scheduled to run weekly.