Skip to main content

Smartwaiver

Smartwaiver is a digital waiver service that turns paper release and consent forms into legally binding electronic documents that customers can sign online or on-site at a kiosk. The Smartwaiver API lets you retrieve signed waivers, templates, check-ins, participant photos and signatures, and account information, and manage dynamic templates, prefilled waiver links, SMS delivery, and webhook configuration.

Smartwaiver icon

Power end-to-end data operations for your Smartwaiver API with Nexla. Our bi-directional Smartwaiver connector is purpose-built for Smartwaiver, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Smartwaiver or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Smartwaiver workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Smartwaiver credential, you need an API key from your Smartwaiver account. The Smartwaiver API uses API key authentication, with the key sent in the sw-api-key request header on every call.

To obtain your Smartwaiver API key, follow these steps:

  1. Sign in to the Smartwaiver Waiver Console with your account credentials.

  2. Click the My Account icon near the top-left of the console, then click API Keys.

  3. Click the Create New API Key button.

  4. Enter a name or label for the key so you can identify how it is used, then click Save API Token.

  5. Your API key is displayed once in a pop-up box. Click Copy Key and store the value in a safe location, as it will not be shown again.

The API key authenticates your requests and grants access to the waivers, templates, and settings on your Smartwaiver account. Treat the key as sensitive information. If it is compromised, delete it in the Waiver Console and generate a new one. For a full list of endpoints and request/response details, see the Smartwaiver API v4 Documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesAPI key.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Smartwaiver API key in the API Key field. This is the key you generated in the Waiver Console under My Account > API Keys, as described in Prerequisites. Nexla sends this value in the sw-api-key header for all requests to the Smartwaiver API.

    The API key provides access to your Smartwaiver account data and should be kept confidential. If the key is compromised, delete it in the Waiver Console and generate a new one.

    For detailed information about authentication and available endpoints, see the Smartwaiver API v4 Documentation.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Smartwaiver connector tile, then select the credential that will be used to connect to Smartwaiver, and click Next; or, create a new Smartwaiver credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Smartwaiver endpoints. 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.

[Rest API] List Templates

This endpoint template retrieves the waiver templates configured on your Smartwaiver account. Use this template when you need the list of templates and their identifiers for reporting or to drive downstream endpoints that require a template ID.

  • This endpoint returns the templates accessible to your API key, including each template's ID and metadata.

For detailed information about templates and the fields returned, see the Smartwaiver API v4 Documentation.

[Rest API] List Signed Waivers

This endpoint template retrieves signed waivers from your Smartwaiver account. Use this template when you need a list of submitted waivers, including their identifiers and summary details.

  • This endpoint returns signed waivers accessible to your API key. Each waiver's ID can be used with the detail, files, photos, and signatures endpoints to retrieve additional information.

For detailed information about waivers and the fields returned, see the Smartwaiver API v4 Documentation.

[Rest API] List Detailed Signed Waiver

This endpoint template retrieves the full details of a single signed waiver, including participant information and the completed form data.

  • This endpoint requires a Waiver ID, the unique identifier of the signed waiver to retrieve. You can obtain waiver IDs from the List Signed Waivers or Search Waivers endpoints.

For detailed information about the waiver detail response, see the Smartwaiver API v4 Documentation.

[Rest API] List Checkins

This endpoint template retrieves check-in records from your Smartwaiver account. Use this template when you need attendance or check-in activity associated with your waivers.

  • This endpoint is paginated. Nexla automatically requests successive pages and stops when no further records are returned.

For detailed information about check-ins and the fields returned, see the Smartwaiver API v4 Documentation.

[Rest API] Get Published Keys

This endpoint template lists the published keys on your Smartwaiver account.

  • This endpoint returns the published keys accessible to your API key.

For detailed information about published keys, see the Smartwaiver API v4 Documentation.

[Rest API] Get User Info

This endpoint template retrieves basic information about the Smartwaiver user account associated with the API key.

  • This endpoint returns account-level information for the authenticated user.

For detailed information about the account info response, see the Smartwaiver API v4 Documentation.

[Rest API] Get Api Key Label

This endpoint template retrieves label information for the API key used to authenticate the request.

  • This endpoint returns the label and related metadata for the current API key.

For detailed information about API key details, see the Smartwaiver API v4 Documentation.

[Rest API] Get User Settings

This endpoint template lists the user settings and configuration for your Smartwaiver account.

  • This endpoint returns the account's settings and configuration values.

For detailed information about account settings, see the Smartwaiver API v4 Documentation.

[Rest API] Get Template Details

This endpoint template retrieves detailed information about your waiver templates, expanding each template returned by the templates list into its full definition.

  • This endpoint first lists your templates and then fetches the detailed configuration for each template it finds.

For detailed information about template definitions, see the Smartwaiver API v4 Documentation.

[Rest API] Get Waiver Files

This endpoint template retrieves the files uploaded with your signed waivers.

  • This endpoint first lists your signed waivers, paginating automatically, and then fetches the files associated with each waiver.

For detailed information about waiver files, see the Smartwaiver API v4 Documentation.

[Rest API] Get Waiver Photos

This endpoint template retrieves the photos uploaded with your signed waivers.

  • This endpoint first lists your signed waivers, paginating automatically, and then fetches the photos associated with each waiver.

For detailed information about waiver photos, see the Smartwaiver API v4 Documentation.

[Rest API] Get Waiver Signatures

This endpoint template retrieves the signature information captured on your signed waivers.

  • This endpoint first lists your signed waivers, paginating automatically, and then fetches the signatures associated with each waiver.

For detailed information about waiver signatures, see the Smartwaiver API v4 Documentation.

[Rest API] Search Waivers

This endpoint template searches for signed waivers that belong to a specific waiver template.

  • This endpoint requires a Template ID, the waiver template whose signed waivers you want to search. You can obtain template IDs from the List Templates endpoint.

For detailed information about searching waivers, see the Smartwaiver API v4 Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Smartwaiver data sources can also be manually configured to ingest data from any valid Smartwaiver API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Smartwaiver data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Smartwaiver destination, and select the Send to Destination option from the menu. Select the Smartwaiver connector from the list of available destination connectors, then select the credential that will be used to connect to Smartwaiver, and click Next; or, create a new Smartwaiver credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Smartwaiver endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Dynamic Template

This endpoint template creates a dynamic waiver template for customers to complete, using records from a Nexset. Use this template when you need to generate waiver templates programmatically from data in your Nexla flows.

  • This endpoint sends each record as JSON in the request body to create a dynamic template. Ensure the record structure matches the format required by the Smartwaiver API.

For detailed information about dynamic templates and the required request body, see the Smartwaiver API v4 Documentation.

[Rest API] Send Waiver SMS

This endpoint template transmits a waiver link via SMS to a specified phone number, using records from a Nexset. Use this template when you need to send waivers to participants by text message.

  • This endpoint sends each record as JSON in the request body. Ensure each record includes the phone number and any other fields required by the Smartwaiver API.

For detailed information about sending waivers by SMS, see the Smartwaiver API v4 Documentation.

[Rest API] Configure Webhook

This endpoint template configures the webhook settings for waiver submissions on your Smartwaiver account, using records from a Nexset.

  • This endpoint sends each record as JSON in the request body using an HTTP PUT to update your webhook configuration. Ensure the record structure matches the format required by the Smartwaiver API.

For detailed information about webhook configuration, see the Smartwaiver API v4 Documentation.

[Rest API] Prefill Template

This endpoint template generates a prefilled waiver link populated with participant data for a given template, using records from a Nexset.

  • This endpoint requires a Template ID, the waiver template for which the prefilled link is generated. Each record is sent as JSON in the request body with the participant data used to prefill the waiver.

For detailed information about prefilled waiver links, see the Smartwaiver API v4 Documentation.

Manual configuration

Smartwaiver destinations can also be manually configured to send data to any valid Smartwaiver API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Smartwaiver endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Smartwaiver endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.