Skip to main content

Apptivo 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 Apptivo location.
apptivo_api.png

Apptivo

Create an Apptivo Destination​

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

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

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

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

    Create Case

    This endpoint creates a new case in the Apptivo Cases app by sending a POST request to v6/cases. In Apptivo, a case represents a customer support ticket or service issue. Use this endpoint to push intake tickets, support requests, or service alerts from upstream systems into Apptivo as cases.

    • No endpoint-specific parameters are required. Each upstream record is sent as the JSON body of the POST call. Use the Nexla transform layer to shape upstream attributes into the field names expected by Apptivo, such as the case subject, description, priority, and customer association.

    For the full set of supported case attributes, see the Apptivo Create Case API reference.

    Create Lead

    This endpoint creates a new lead in the Apptivo Leads app by sending a POST request to v6/leads. Leads represent prospective customers at the top of your sales funnel. Use this endpoint to programmatically push leads from upstream sources — for example, web form submissions, marketing tools, or imported lists — into Apptivo.

    • No endpoint-specific parameters are required. Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the Apptivo lead field names, such as firstName, lastName, companyName, emailAddress, and leadSource.

    For the full set of supported lead attributes, see the Apptivo Create Lead API reference.

    Create Customer

    This endpoint creates a new customer in the Apptivo Customers app by sending a POST request to v6/customers. Customers in Apptivo represent organizations or companies in your CRM. Use this endpoint to provision customer records in Apptivo from upstream systems such as billing platforms or signup flows.

    • No endpoint-specific parameters are required. Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the Apptivo customer field names, such as customerName, customerNumber, address fields, and any custom fields configured for your firm.

    For the full set of supported customer attributes, see the Apptivo Customers API reference.

    Delete Customer

    This endpoint deletes a customer by ID from the Apptivo Customers app by sending a DELETE request to v6/customers/<customerId>. Use it to remove customer records from Apptivo when they are deleted in an upstream system of record. The deletion is permanent, so validate upstream data carefully before activating this destination.

    • Enter the customer identifier in the Customer ID field. This field is required and identifies the customer record to delete. To drive the destination from an upstream source, map the upstream record's customer ID into this field.

    Because deletion is irreversible, consider routing through a Nexla transform that filters to only the customers that should genuinely be deleted before activating this destination.

    Create Contact

    This endpoint creates a new contact in the Apptivo Contacts app by sending a POST request to v6/contacts. Contacts represent individual people, typically associated with a customer organization. Use this endpoint to push contacts into Apptivo from upstream marketing or identity systems.

    • No endpoint-specific parameters are required. Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the Apptivo contact field names, such as firstName, lastName, emailAddress, phone fields, and any custom fields configured for your firm.

    Create Opportunity

    This endpoint creates a new opportunity in the Apptivo Opportunities app by sending a POST request to v6/opportunities. Opportunities represent active sales deals tracked through your pipeline. Use this endpoint to push deals from upstream sources — for example, a lead conversion in another system — into Apptivo. Optional query parameters allow conversion behavior, duplicate handling, and territory updates to be controlled per call.

    • Enter the related account identifier in the Account ID field. This optional field is used to associate the new opportunity with an existing customer account in Apptivo.
    • Set the Is Duplicate field to control duplicate-checking behavior on the new opportunity. This optional flag instructs Apptivo whether to treat the request as a duplicate-aware create. Refer to the Apptivo opportunities documentation for accepted values.
    • Set the Is Lead Convert field to indicate whether this opportunity is being created as part of a lead conversion. This optional flag is typically set when an upstream lead is being promoted to an opportunity in Apptivo.
    • Set the Is Customer Territory Update field to indicate whether the associated customer's territory should be updated as part of this operation. This optional flag is useful when upstream territory ownership changes should be reflected in Apptivo.
    • Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the Apptivo opportunity field names, such as opportunityName, amount, salesStage, and any custom fields configured for your firm.

    For the full set of supported opportunity attributes and parameter values, see the Apptivo Create Opportunity API reference.

Configure Manually​

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

Using manual configuration, you can also configure Nexla to automatically send the response received from the Apptivo API after each call to a new Nexla webhook data source.

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 Apptivo API from the Method pulldown menu. Use POST to create records (for example, on the save action), PUT to update existing records, and DELETE to remove records.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Apptivo API from the Content Format pulldown menu. The Apptivo API uses JSON as the exchange format, so application/json is the appropriate selection for most operations. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Apptivo API endpoint to which you want to send the Nexset data in the URL field. Apptivo write endpoints follow the format https://api.apptivo.com/app/dao/v6/<object> with an action selector — for example, https://api.apptivo.com/app/dao/v6/leads?a=save. For update or delete operations, include the relevant object ID in the URL path (for example, v6/customers/<customerId>). The apiKey and accessKey parameters are appended to the URL automatically by Nexla based on your 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 any headers already present in the credentials. The Apptivo apiKey and accessKey parameters are handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Apptivo 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.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

The Apptivo write endpoints typically create or modify a single record per call. Record batching is best suited to custom endpoints that accept multiple records in one request — confirm the target Apptivo endpoint supports batched payloads before enabling this option.

Response Webhook​

Optional

Nexla can automatically send the response received from the Apptivo 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 after each call — for example, the new identifier and timestamps that Apptivo assigns to a newly created customer, lead, contact, opportunity, or case.

  • 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 Apptivo 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 Apptivo 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 Apptivo 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 Apptivo, open the destination resource menu, and select Activate.

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