Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Brex source in Nexla.
brex_api.png

Brex

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Brex connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Brex instance, and click Next; or, create a new Brex credential for use in this flow.

  3. In Nexla, Brex data sources can be created using pre-built endpoint templates, which expedite source setup for common Brex endpoints. Each template is designed specifically for the corresponding Brex endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Brex sources can also be configured manually, allowing you to ingest data from Brex endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Brex endpoints. Each template is designed specifically for the corresponding Brex endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List referrals

    This endpoint retrieves a list of referrals created in your Brex account. Note that this endpoint does not include referrals that have expired. Use this endpoint when you need to access referral information for tracking, analysis, or reporting purposes.

    • This endpoint automatically retrieves all active referrals from your Brex account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://platform.brexapis.com/v1/referrals. The endpoint URL is automatically constructed based on the Brex API base URL.
    • The endpoint uses token-based pagination, automatically fetching additional pages as needed using the next_cursor query parameter. When a response includes a next_cursor field, Nexla automatically includes it in the subsequent request to fetch the next page of results.
    • The endpoint will return all active referrals in your account. The response data is extracted from the items array in the API response ($.items[*]), with each referral record processed individually.

    This endpoint supports pagination through the next_cursor token mechanism. When a response includes a next_cursor field, Nexla automatically includes it as the next_cursor query parameter in the subsequent request to fetch the next page of results. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the next_cursor mechanism. The response data path is $.items[*], which extracts all items from the items array in the API response. Note that this endpoint does not include expired referrals. For detailed information about retrieving referrals, see the Brex API documentation.

    List Users

    This endpoint retrieves a list of all users in your Brex account. To find a user ID by email, you can filter using the email query parameter in manual configuration. Use this endpoint when you need to access user information for team management, access control, or user analysis.

    • This endpoint automatically retrieves all users from your Brex account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://platform.brexapis.com/v2/users. The endpoint URL is automatically constructed based on the Brex API base URL.
    • The endpoint uses token-based pagination, automatically fetching additional pages as needed using the next_cursor query parameter. When a response includes a next_cursor field, Nexla automatically includes it in the subsequent request to fetch the next page of results.
    • The endpoint will return all users in your account. The response data is extracted from the items array in the API response ($.items[*]), with each user record processed individually.

    This endpoint supports pagination through the next_cursor token mechanism. When a response includes a next_cursor field, Nexla automatically includes it as the next_cursor query parameter in the subsequent request to fetch the next page of results. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the next_cursor mechanism. The response data path is $.items[*], which extracts all items from the items array in the API response. You can filter users by email address using the email query parameter in manual configuration. For detailed information about retrieving users, see the Brex API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Brex data sources can be manually configured to ingest data from any valid Brex API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Brex sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Brex API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Brex API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Brex API endpoints typically follow the pattern https://platform.brexapis.com/v{version}/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Bearer token authentication in the Authorization header, which is handled automatically by your credential configuration. For detailed information about Brex API endpoints and available APIs, see the Brex API documentation.

Path to Data​

  1. Enter the JSON path that identifies the location of the relevant data within the API response in the Path to Data field. JSON paths use dot notation to navigate through nested JSON structures.

    • For example, if your API response has the structure {"items": [...]}, you would enter $.items[*] to extract all items from the items array.
    • Use $[*] to extract all items from a root-level array.
    • Use $ to extract the entire root-level object.

JSON paths are case-sensitive and must match the exact structure of your API response. Brex API responses typically use an items array to contain the actual data. Use the Test button to verify that your JSON path correctly extracts the desired data from the API response.

Save the Data Source​

  1. Once all configuration steps have been completed, click the Save button to save your data source configuration.

  2. The data source will now be available in your data flow and will begin ingesting data according to the configured schedule and endpoint settings.