Set up your connector

Choose connector capabilities

Decide what your connector supports and identify the workers, mappings and permissions each capability needs.

Implement the capabilities your integration needs. Declare and test every capability you expose.

CapabilityRequired implementationDependencies and verification
Sync-unit discoveryExternal sync units workerReturn stable units the connected account can access
MetadataMetadata workerSupply EDM matching extraction, including supported references and custom fields
Initial/incremental extractionData workerMapping, stable IDs, pagination, continuation and resolved time windows
Selective extractionScope filteringEmit only enabled record types, including correct dependent references
Historical extractionTime-window filteringHonor resolved lower and upper bounds; verify provider filtering behavior
Attachment extractionAttachment workerDiscover attachment metadata, resolve owners and stream authorized file content
Custom attachment processingProcessorsStream files and preserve valid attachment/output associations
Permission importPermission metadata and recordsPrincipals, memberships and access rules; test restricted access
Team importTeam schema and membership mappingsStable team/member identity and valid relationships
Reverse data syncData loaderExternal write scopes, supported operations, denormalization and identity mappers
Reverse attachment syncAttachment loaderOwner mapping, accessible file stream and provider upload endpoint
Rich text/articlesRich-text mappingTarget-specific format and attachment links

The template and Asana may not implement every AirSync capability. Check each example's declared coverage in the code map.

Check the external API

Record the endpoints and scopes behind every claimed operation, a sample external response for each record type, supported field mappings, unavailable provider features and expected pagination/rate-limit behavior. Validate these against a provider test account before broadening the connector's manifest capabilities.

Next: Declare connector capabilities.

Last updated on