nango.yaml
file, which lives in your code base.
integrations.<INTEGRATION-ID>
.
integrations.<INTEGRATION-ID>.syncs.<SYNC-NAME>
.
endpoint
field below.GET
The method/endpoint combination can be shared across syncs to unify the communication with external APIs.
The group
is an optional value to group endpoints across scripts.Legacy format: <METHOD> <URL-PATH>
. e.g.: GET /tasks
.full
) or upserts it (incremental
).Learn more about incremental vs. full refresh syncing.true
, automatically starts synchronizing between the external API and Nango when a new connection is created. Otherwise, it needs to be triggered via the API or Nango UI.Defaults to true
.track_deletes
is set to true
, Nango automatically detects deleted records during full syncs only and marks them as deleted in each record’s metadata (soft delete). These records remain stored in the cache.When set to false
, Nango does not mark missing records as deleted, even if they weren’t returned in the latest full sync—they simply remain in the cache unchanged.Defaults to false
.sync_type: full
(details). For incremental syncs, this setting is ignored; instead, you must flag deleted records in the sync script using nango.batchDelete()
(reference).integrations.<INTEGRATION-ID>.actions.<ACTION-NAME>
.
endpoint
field below.GET
, POST
, PUT
, PATCH
, DELETE
.The method/endpoint combination can be shared across actions to unify the communication with external APIs.
The group
is an optional value to group endpoints across scripts.Legacy format: <METHOD> <URL-PATH>
. e.g.: POST /tasks
.on-events
configuration fields are under integrations.<INTEGRATION-ID>.on-events.<EVENT-NAME>
.
nango.yaml type | Corresponding Typescript type |
---|---|
bool or boolean | boolean |
string | string |
char or varchar | string |
integer or int or number or bigint or float | number |
date | Date |
null | null |
undefined | undefined |
any | any |
array | any[] |
object | object |
true or false | true orfalse |
|
notation, we check each element against known Typescript types, to categorize it as type (if match) or string (if no match).nango deploy
CLI command.
These changes can have significant impacts, in particular, if you:
autoStart: false
, the deployment will kick off the data synchronization between the external API and Nango, for all relevant connections.
This change will be reflected in the Nango UI in Integrations > select your integration > Endpoints tab.