Skip to main content

Data Source

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

Quip

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

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

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

    Get Contacts

    This endpoint template returns a list of the contacts for the authenticated user from your Quip account. Use this template when you need to retrieve information about contacts, including contact IDs, names, and other contact metadata. Click on API Documentation URL for more information.

    • This endpoint automatically retrieves all contacts for the authenticated user from your Quip account. No additional configuration is required beyond selecting this endpoint template.

    This endpoint returns a list of contacts for the authenticated user from your Quip account, including contact IDs, names, and other contact metadata. Use this endpoint to discover which contacts are available in your Quip account.

    For detailed information about contact management, API response structures, and available contact data, see the Quip API documentation.

    Get Information for Users

    This endpoint template retrieves information for users from your Quip account. Input users as a comma-separated list of emails or IDs. Use this template when you need to retrieve information about specific users, including user IDs, names, and other user metadata. Click on API Documentation URL for more information.

    • Enter the users list in the Users List field. This should be a comma-separated list of user emails or IDs for which you want to retrieve information (e.g., user1@example.com,user2@example.com or 12345,67890). The users list determines which users' information will be retrieved.

    This endpoint returns information for users from your Quip account, including user IDs, names, and other user metadata. The endpoint accepts a comma-separated list of user emails or IDs and returns information for all specified users.

    For detailed information about user management, API response structures, and available user data, see the Quip API documentation.

    Search for Threads

    This endpoint template returns threads whose content matches words in the given query from your Quip account. Use this template when you need to search for threads based on content or keywords. Click on API Documentation URL for more information.

    • Enter the search query in the Query field. This should be the search query containing words you want to match in thread content. The query determines which threads will be returned based on content matching.
    • Select whether to only match titles from the Match Titles field. Available options include true (only match thread titles) and false (match thread content). The match titles option determines whether the search will be limited to thread titles or include thread content.

    This endpoint returns threads whose content matches words in the given query from your Quip account, including thread IDs, titles, and other thread metadata. The endpoint returns up to 50 matching threads by default.

    For detailed information about thread search, API response structures, and available thread data, see the Quip API documentation.

    Get Recent Threads

    This endpoint template returns the most recent threads to have received messages from your Quip account, similar to the updates view in the Quip app. Use this template when you need to retrieve recently updated threads. Click on API Documentation URL for more information.

    • This endpoint automatically retrieves the most recent threads from your Quip account. No additional configuration is required beyond selecting this endpoint template.

    This endpoint returns the most recent threads to have received messages from your Quip account, including thread IDs, titles, and other thread metadata. The endpoint returns threads similar to the updates view in the Quip app.

    For detailed information about recent threads, API response structures, and available thread data, see the Quip 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​

Quip data sources can be manually configured to ingest data from any valid Quip 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 Quip sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

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 Quip API from the Method pulldown menu. Quip API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Quip API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Quip endpoint (e.g., https://platform.quip.com/1/users/contacts, https://platform.quip.com/1/threads/recent). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Quip API endpoint URL should include the API version (/1/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Quip API responses, use $[*] to extract all items from the response array, or $ to extract the entire response for single record endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Quip API response. Quip API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.