Skip to main content

Asana

This connector captures data from Asana's REST API.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-asana:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

Supported data resources

The following data resources are supported through the Asana APIs:

Default Streams

Streams Available for Enterprise+ Organizations

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

Prerequisites

You will need an Asana account.

You can authenticate your account with Estuary either via OAuth or using an Asana personal access token.

Configuration

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

Properties

Endpoint

PropertyTitleDescriptionTypeRequired/Default
/credentialsCredentialsobjectRequired
/credentials/option_titleCredentials TitleDenotes the authentication type. Can either be OAuth Credentials or PAT Credentials.string
/credentials/client_idClient IDThe client ID for Asana OAuth.stringRequired when using the OAuth Credentials option
/credentials/client_secretClient SecretThe client secret for Asana OAuth.stringRequired when using the OAuth Credentials option
/credentials/refresh_tokenRefresh TokenThe refresh token for Asana OAuth.stringRequired when using the OAuth Credentials option
/credentials/personal_access_tokenPersonal Access TokenThe access token to authenticate with the Asana API.stringRequired when using the PAT Credentials option

Bindings

PropertyTitleDescriptionTypeRequired/Default
/streamStreamAsana resource from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired

Sample


captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-asana:dev
config:
credentials:
option_title: PAT Credentials
personal_access_token: <secret>
bindings:
- resource:
stream: attachments
syncMode: full_refresh
target: ${PREFIX}/attachments
{...}