integrations.<INTEGRATION-ID>
.
integrations.<INTEGRATION-ID>.syncs.<SYNC-NAME>
.
endpoint
field below.<METHOD> <URL-PATH>
. e.g.: GET /tasks
.Possible method values are: GET
, POST
, PUT
, PATCH
, DELETE
.The method/endpoint combination can be shared across syncs to unify the communication with external APIs.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
.true
, automatically detects deleted records and flags them when you fetch the latest data.Defaults to false
.integrations.<INTEGRATION-ID>.actions.<ACTION-NAME>
.
endpoint
field below.<METHOD> <URL-PATH>
. e.g.: POST /tasks
.Possible method values are: GET
, POST
, PUT
, PATCH
, DELETE
.The method/endpoint combination can be shared across actions to unify the communication with external APIs.models
section contains the schemas referenced in the inputs & outputs of the above integrations
section.
nango.yaml type | Corresponding Typescript type |
---|---|
bool or boolean | boolean |
string | string |
char | string |
integer or int or number | number |
date | Date |
undefined
, null
, and more.
[]
notation:
|
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:
auto_start=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 > Script tab.
nango.yaml
configuration are used to generate Typescript models (in the nango-integrations/models.ts
file).
You can then import the relevant models from models.ts
in your integration scripts.