Skip to main content

Front

This connector captures data from Front into Estuary collections.

Supported data resources​

The following data resources are supported through the Front API:

By default, each resource is mapped to an Estuary collection through a separate binding.

Prerequisites​

  • A Front API token with the appropriate scope(s).

Configuration​

You configure connectors either in the Estuary web app, or by directly editing the catalog specification files. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Front source connector.

Properties​

Endpoint​

PropertyTitleDescriptionTypeRequired/Default
/credentials/access_tokenAPI KeyYour Front API token.stringRequired
/start_dateReplication Start DateUTC date and time in the format "YYYY-MM-DDTHH:MM:SSZ". Data prior to this date will not be replicated.string

Bindings​

PropertyTitleDescriptionTypeRequired/Default
/nameData resourceResource in Front from which collections are captured.stringRequired

Sample​

captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-front:v3
config:
credentials:
access_token: <secret>
start_date: "2024-11-15T00:00:00Z"
bindings:
- resource:
name: channels
target: ${PREFIX}/channels
- resource:
name: contacts
target: ${PREFIX}/contacts
- resource:
name: conversations
target: ${PREFIX}/conversations
- resource:
name: events
target: ${PREFIX}/events
- resource:
name: inboxes
target: ${PREFIX}/inboxes
- resource:
name: tags
target: ${PREFIX}/tags
- resource:
name: teammates
target: ${PREFIX}/teammates
- resource:
name: teams
target: ${PREFIX}/teams