Skip to main content

Data Source

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

PandaDoc API

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

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

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

    Fetch Resources of a Type

    This endpoint template returns a list of resources of a specific type from your PandaDoc account. Use this template when you need to retrieve contacts, members, or other PandaDoc resources associated with your workspace.

    • Select the resource type from the Resource Type pulldown menu. Available options include Contacts (contacts) and Members (members). The resource type determines which PandaDoc resource will be queried. Select the resource type that matches the data you want to retrieve.

    This endpoint returns a list of resources of a specific type from your PandaDoc account, including contacts and members associated with your workspace. The endpoint returns all available resources of the specified type without pagination.

    For detailed information about resource types, API response structures, and available resource data, see the PandaDoc API documentation.

    Document Status

    This endpoint template retrieves basic data about a document such as name, status, and dates from your PandaDoc account. Use this template when you need to retrieve document status information, including document names, current status, creation dates, and other basic document metadata.

    • Enter the document ID in the Document ID field. This should be the unique identifier of the document for which you want to retrieve status information. The document ID determines which document's status will be retrieved. You can find the document ID in your PandaDoc account or in document URLs.

    This endpoint retrieves basic data about a document from your PandaDoc account, including document name, status, creation date, modification date, and other basic document metadata. The endpoint returns a single document's status information.

    For detailed information about document status, API response structures, and available document data, see the PandaDoc API documentation.

    Document Details

    This endpoint template returns detailed data about a document from your PandaDoc account. Use this template when you need to retrieve comprehensive document information, including document content, fields, recipients, and other detailed document data.

    • Enter the document ID in the Document ID field. This should be the unique identifier of the document for which you want to retrieve detailed information. The document ID determines which document's details will be retrieved. You can find the document ID in your PandaDoc account or in document URLs.

    This endpoint returns detailed data about a document from your PandaDoc account, including document content, fields, recipients, status, dates, and other comprehensive document information. The endpoint returns a single document's detailed information.

    For detailed information about document details, API response structures, and available document data, see the PandaDoc 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​

PandaDoc data sources can be manually configured to ingest data from any valid PandaDoc 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 PandaDoc 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 PandaDoc API from the Method pulldown menu. PandaDoc API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the PandaDoc API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your PandaDoc endpoint (e.g., https://api.pandadoc.com/public/v1/contacts, https://api.pandadoc.com/public/v1/documents/{document_id}). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The PandaDoc API endpoint URL should include the API version (/public/v1/) 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 PandaDoc API responses, use $.results[*] to extract all items from the results 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 PandaDoc API response. PandaDoc 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.