|
| 1 | +# Navan |
| 2 | + |
| 3 | +This connector captures data from Navan into Flow collections. |
| 4 | + |
| 5 | +It is available for use in the Flow web application. For local development or open-source workflows, [`ghcr.io/estuary/source-navan:dev`](https://ghcr.io/estuary/source-navan:dev) provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions. |
| 6 | + |
| 7 | +## Supported data resources |
| 8 | + |
| 9 | +The following data resources are supported through the Navan API: |
| 10 | + |
| 11 | +* [Bookings](https://app.navan.com/app/helpcenter/articles/travel/admin/other-integrations/booking-data-integration) |
| 12 | + |
| 13 | +By default, each resource is mapped to a Flow collection through a separate binding. |
| 14 | + |
| 15 | +## Prerequisites |
| 16 | + |
| 17 | +The Navan API requires that an OAuth application is set up in the Admin dashboard. The `client_id` and `client_secret` are then used to authenticate the connector to your OAuth app to request data. See https://app.navan.com/app/helpcenter/articles/travel/admin/other-integrations/booking-data-integration for more details. |
| 18 | + |
| 19 | +## Configuration |
| 20 | + |
| 21 | +You configure connectors either in the Flow web app, or by directly editing the catalog specification files. |
| 22 | +See [connectors](../../../concepts/connectors.md#using-connectors) to learn more about using connectors. The values and specification sample below provide configuration details specific to the Navan source connector. |
| 23 | + |
| 24 | +### Properties |
| 25 | + |
| 26 | +#### Endpoint |
| 27 | + |
| 28 | +| Property | Title | Description | Type | Required/Default | |
| 29 | +|---|---|---|---|---| |
| 30 | +| **`/credentials/credentials_title`** | Authentication Method | Set to `OAuth Credentials`. | string | Required | |
| 31 | +| **`/credentials/client_id`** | Client ID | The client ID obtained from the OAuth app set up in Navan dashboard. | string | Required for OAuth2 authentication | |
| 32 | +| **`/credentials/client_secret`** | Client Secret | The client secret obtained from the OAuth app set up in Navan dashboard. | string | Required for OAuth2 authentication | |
| 33 | + |
| 34 | + |
| 35 | +#### Bindings |
| 36 | + |
| 37 | +| Property | Title | Description | Type | Required/Default | |
| 38 | +|---|---|---|---|---| |
| 39 | +| **`/name`** | Data resource | Name of the data resource. | string | Required | |
| 40 | +| `/interval` | Interval | Interval between data syncs | string | | |
| 41 | + |
| 42 | +### Sample |
| 43 | + |
| 44 | +```yaml |
| 45 | +captures: |
| 46 | + ${PREFIX}/${CAPTURE_NAME}: |
| 47 | + endpoint: |
| 48 | + connector: |
| 49 | + image: ghcr.io/estuary/source-navan:dev |
| 50 | + config: |
| 51 | + credentials: |
| 52 | + credentials_title: OAuth Credentials |
| 53 | + client_id: secret_client_id_value |
| 54 | + client_secret: secret_client_secret_value |
| 55 | + bindings: |
| 56 | + - resource: |
| 57 | + name: bookings |
| 58 | + target: ${PREFIX}/bookings |
| 59 | +``` |
0 commit comments