Developers · Preview documentation

Documentation.

Concepts, a quickstart and reference for the Nextra Flow API. Search with / or Cmd+K.

Getting started / Introduction

Getting started

Introduction

What Nextra Flow is and the six concepts the API is built around.

Nextra Flow translates data between business systems. You connect systems once, describe how their fields relate, and Nextra Flow moves each record through mapping, normalization, validation and delivery, recording every run.

Core concepts

  • Connection: authenticated access to a system such as an application, database, API, webhook endpoint or file location.
  • Schema: the fields and types a system exposes, read from the system or from sample records.
  • Mapping: how fields in a source schema correspond to fields in a destination schema.
  • Transformation: a rule that cleans or reshapes a value, for example normalizing a phone number to E.164.
  • Flow: a connection to read from, a mapping, transformations, validation and a destination.
  • Run: one execution of a flow. Every run has an ID, per-stage timings and field-level errors.

Base URL

URLIllustrative
https://api.nextranslate.example/v1

All requests use HTTPS and exchange JSON. Next: run the quickstart, or read how authentication works.