Skip to main content

Fulcrum Data Source

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

Fulcrum

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 Fulcrum connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Fulcrum instance, and click Next; or, create a new Fulcrum credential for use in this flow.

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

    Fulcrum sources can also be configured manually, allowing you to ingest data from Fulcrum 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 Fulcrum endpoints. Each template is designed specifically for the corresponding Fulcrum 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.

    Records get all

    Retrieve all records from your Fulcrum account.

    • This endpoint automatically retrieves all records from your Fulcrum account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://api.fulcrumapp.com/api/v2/records.json. The endpoint URL is automatically constructed based on the Fulcrum API base URL.
    • The endpoint uses incrementing pagination, automatically fetching additional pages as needed. Pagination starts from page 1 and increments by 1 for each subsequent page. Nexla will continue fetching pages until all records are retrieved.
    • The endpoint will return all records in your Fulcrum account. The response data is extracted from the records array in the API response ($.records[*]), with each record processed individually.

    This endpoint retrieves all records from your Fulcrum account. Records represent data entries collected through your Fulcrum forms. The endpoint uses incrementing pagination (iteration.type: paging.incrementing) starting from page 1. The response data path is $.records[*], which extracts all items from the records array in the API response. For detailed information about retrieving records, see the Fulcrum API documentation.

    Get all projects

    Retrieve all projects from your Fulcrum account.

    • This endpoint automatically retrieves all projects from your Fulcrum account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://api.fulcrumapp.com/api/v2/projects.json. The endpoint URL is automatically constructed based on the Fulcrum API base URL.
    • The endpoint uses incrementing pagination, automatically fetching additional pages as needed. Pagination starts from page 1 and increments by 1 for each subsequent page. Nexla will continue fetching pages until all projects are retrieved.
    • The endpoint will return all projects in your Fulcrum account. The response data is extracted from the projects array in the API response ($.projects[*]), with each project processed individually.

    This endpoint retrieves all projects from your Fulcrum account. Projects are containers for forms and records in Fulcrum. The endpoint uses incrementing pagination (iteration.type: paging.incrementing) starting from page 1. The response data path is $.projects[*], which extracts all items from the projects array in the API response. For detailed information about retrieving projects, see the Fulcrum 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​

Fulcrum data sources can be manually configured to ingest data from any valid Fulcrum 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 Fulcrum 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 Fulcrum 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 Fulcrum 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. Fulcrum API endpoints typically follow the pattern https://api.fulcrumapp.com/api/v2/{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 API Token authentication via the X-ApiToken header, which is handled automatically by your credential configuration. For detailed information about Fulcrum API endpoints and available APIs, see the Fulcrum API documentation.