Skip to main content

HelloSign Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a HelloSign location.
hellosign_api.png

HelloSign

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

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

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

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

    Download files as Data URI

    Obtain a copy of the current documents specified by the signature_request_id parameter.

    • Enter the signature request ID you want to download files for in the Signature Request ID field. This should be the unique identifier for the signature request whose documents you want to retrieve.
    • The endpoint uses GET requests to https://api.hellosign.com/v3/signature_request/files_as_data_uri/{signature_request_id} where {signature_request_id} is the Signature Request ID you provide. The endpoint URL is automatically constructed based on the HelloSign API base URL and the signature request ID.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $, which extracts the entire root-level object from the API response. The response contains the document files encoded as data URIs.

    This endpoint retrieves a copy of the current documents for a specific signature request, with the files encoded as data URIs. Data URIs allow the document content to be embedded directly in the response as base64-encoded data. The signature request must exist in your HelloSign account, and you must have permission to access it. For detailed information about the API response format and available fields, see the HelloSign API documentation.

    Get Signature Request List

    Returns a list of SignatureRequests that you can access.

    • Enter the account ID for which you want to retrieve signature requests in the Account ID field. This should be the account ID of the team member whose signature requests you want to retrieve. Use all to indicate all team members. The default value is all if not specified.
    • The endpoint uses GET requests to https://api.hellosign.com/v3/signature_request/list?account_id={account_id} where {account_id} is the Account ID you provide. The endpoint URL is automatically constructed based on the HelloSign API base URL and the account ID query parameter.
    • The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing) starting from page 1. The response data path is $.signature_requests[*], which extracts all items from the signature_requests array in the API response.
    • The endpoint fetches 20 records per page by default and automatically fetches additional pages until all signature requests have been retrieved.

    This endpoint retrieves a list of signature requests that you can access in your HelloSign account. You can specify an account ID to retrieve signature requests for a specific team member, or use all to retrieve signature requests for all team members. The endpoint supports pagination through incrementing page numbers, which allows you to retrieve large lists of signature requests efficiently. The response includes pagination metadata that indicates the current page and total pages available. For detailed information about the API response format and available fields, see the HelloSign API documentation.

    Download Files as File Url

    Obtain a copy of the current documents specified by the signature_request_id parameter.

    • Enter the signature request ID you want to download files for in the Signature Request ID field. This should be the unique identifier for the signature request whose documents you want to retrieve.
    • The endpoint uses GET requests to https://api.hellosign.com/v3/signature_request/files_as_file_url/{signature_request_id} where {signature_request_id} is the Signature Request ID you provide. The endpoint URL is automatically constructed based on the HelloSign API base URL and the signature request ID.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $, which extracts the entire root-level object from the API response. The response contains URLs to download the document files.

    This endpoint retrieves a copy of the current documents for a specific signature request, with the files provided as download URLs. The URLs are temporary and can be used to download the document files. The signature request must exist in your HelloSign account, and you must have permission to access it. For detailed information about the API response format and available fields, see the HelloSign API documentation.

Configure Manually​

HelloSign data sources can be manually configured to ingest data from any valid HelloSign 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 HelloSign sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the HelloSign API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The HelloSign API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the HelloSign 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. HelloSign API endpoints typically follow the pattern https://api.hellosign.com/v3/{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 authentication via either API Key (Basic authentication) or OAuth2 (Bearer token), which is handled automatically by your credential configuration. For detailed information about HelloSign API endpoints and available APIs, see the HelloSign API documentation.