Skip to main content

Amperity Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an Amperity location.
amperity_api.png

Amperity

Create an Amperity Destination​

  1. Click the + icon on the Nexset that will be sent to the Amperity destination, and select the Send to Destination option from the menu.

  2. Select the Amperity connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Amperity tenant, and click Next; or, create a new Amperity credential for use in this flow.

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

    Amperity destinations can also be configured manually, allowing you to send data to Amperity endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Amperity API endpoints. Each template is designed specifically for the corresponding Amperity endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, 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.

    Start Workflow Run

    This endpoint triggers a new run of an existing Amperity workflow. Use this template when you need to programmatically launch Amperity workflows in response to upstream data events, such as starting a data refresh or a model retraining workflow after new data arrives in Nexla.

    • Ensure the data being sent to this destination includes the required fields for the workflow run request. The Amperity API expects a JSON payload containing the workflow ID and any run-specific parameters.

    • The workflow ID can be obtained from the Amperity UI by navigating to the Workflows section, or by using the List Workflows data source endpoint to retrieve the IDs of available workflows programmatically.
    • After sending the request, the Amperity API returns a workflow run ID and status. Enable the Response Webhook option in the destination configuration to capture this response data as a new Nexla source for downstream processing or status tracking.

    For additional information about triggering workflows via the Amperity API, refer to the Amperity POST /workflow/runs documentation.

Configure Manually​

Amperity destinations can be manually configured to send data to any valid Amperity API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Amperity API after each call to a new Nexla webhook data source. This is useful for capturing confirmation data, resource IDs, or status information returned by the Amperity API after a write operation.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Amperity API from the Method pulldown menu. Common methods for Amperity write operations include:

    • POST: For creating new resources or triggering actions (e.g., starting a workflow run, submitting ingest jobs)
    • PUT: For replacing existing resources with new data
    • PATCH: For partially updating existing resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the Amperity API from the Content Format pulldown menu. The Amperity API expects data in JSON format for all write operations. Nexla will automatically convert the Nexset data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Amperity API endpoint to which you want to send the Nexset data in the URL field. All Amperity API endpoint URLs follow the format https://{tenant-id}.amperity.com/api/{endpoint-path}, where {tenant-id} is your Amperity tenant ID. For example, to trigger a workflow run, use https://your-tenant.amperity.com/api/workflow/runs.

For the complete list of Amperity API endpoints that support write operations, refer to the Amperity API Endpoints reference. Ensure the URL uses your specific tenant ID, which is available in your Amperity credential configuration.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization or Amperity-Tenant headers here — those are automatically managed by Nexla using the values from your Amperity credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Amperity destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Amperity API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned — such as workflow run IDs or confirmation payloads — after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Amperity API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Amperity API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Amperity API using the current settings.

Save & Activate the Destination​

  • 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 begin sending data to the configured Amperity endpoint, open the destination resource menu, and select Activate.

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