rocketkind
DevTools

Nango

Nango is the integration layer your own product uses to connect to your customers' third-party accounts: it holds each customer's OAuth or API-key connection, runs syncs that copy their data into records, and runs action functions against their accounts.

Authentication

  • API key

Actions

Generic API request. Call any Nango API endpoint on this connection, for the case where no shipped action covers it yet — for example the proxy, connection metadata, or integration functions. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Create connect session (v1)Start a Nango Connect session so one of your end users can authorize an integration - Nango's hosted Connect UI walks them through OAuth or API-key entry and the new connection carries the tags you set here (for example enduserid), which is how you match it back to your user.
  • Delete connection (v1)DestructivePermanently delete one end-user connection from Nango - its stored credentials, its syncs and the records they collected - for example when a customer disconnects an integration in your product.
  • Get connection (v1)Read one Nango connection - its integration, provider, metadata, tags, connection config, open errors and when its credentials expire - to check whether a customer's authorization is healthy or to read the metadata your app stored on it.
  • Get integration (v1)Read one Nango integration by its id, e.g. to check which provider it wraps or the webhook URL to register with that provider.
  • Get sync status (v1)Report the state of Nango syncs for an integration - running, paused, stopped, succeeded or failed - with when each last finished, when it runs next, its frequency and how many records it holds per model.
  • List connections (v1)List the end-user connections in this Nango environment - one per customer account that has authorized an integration - optionally narrowed to one connection id, a partial search, or tags.
  • List integrations (v1)List every integration configured in this Nango environment - one per external API you have set up, such as a GitHub or Salesforce app.
  • List records (v1)Read the records a Nango sync has collected for one connection and one data model - for example the GithubIssue records of a customer's GitHub connection - optionally only those changed since a cursor or timestamp.
  • Pause sync schedule (v1)DestructivePause the schedule of one or more Nango syncs, for one connection or for every connection of the integration - for example while a customer's account is suspended or to stop spending the provider's rate limit.
  • Start sync schedule (v1)DestructiveResume the schedule of one or more paused Nango syncs, for one connection or for every connection of the integration.
  • Trigger action (v1)DestructiveRun a Nango action function against one customer's connection and return its result - for example create-issue on their GitHub, or fetch a single record on demand.
  • Trigger sync (v1)DestructiveRun one or more Nango syncs once, right now, in addition to their schedule - for example after a customer connects an account and you want their data before the next scheduled run.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.