Skip to main content

SmartEngage

SmartEngage is a cross-channel marketing automation platform that links a contact's email, SMS, Facebook Messenger, and web push subscriptions into a single subscriber profile. The Nexla connector uses the SmartEngage REST API to read avatars, tags, custom fields, sequences, and subscribers, and to write subscriber and tag changes back to your account.

SmartEngage icon

Power end-to-end data operations for your SmartEngage API with Nexla. Our bi-directional SmartEngage connector is purpose-built for SmartEngage, 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 SmartEngage or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your SmartEngage 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 SmartEngage credential, you need an API key from your SmartEngage account. The SmartEngage API authenticates requests using bearer authentication, with the key sent in the Authorization header in the format Authorization: Bearer <api-key>. All requests are made over HTTPS to https://api.smartengage.com/.

To obtain your API key, follow these steps:

  1. Sign in to your SmartEngage account.

  2. Open the API keys area of your account settings from the SmartEngage dashboard.

  3. Copy an existing API key, or create a new one for use with Nexla.

  4. Store the API key securely, as you will need it to configure your Nexla credential. Treat the key as sensitive information and keep it confidential.

For detailed information about authentication and available endpoints, refer to the SmartEngage API Reference.

Authenticate​

Credentials required​

FieldRequiredSecretDescription
API KeyYesYesSmartEngage API key used to authenticate requests.

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 SmartEngage API key in the API Key field. This key is sent as a bearer token in the Authorization header for all API requests and must be kept confidential.

    If your API key is compromised, revoke it in your SmartEngage account and generate a new one. The API key grants access to your SmartEngage subscriber and account data and should be treated as sensitive information.

    For detailed information about authentication and available endpoints, see the SmartEngage API Reference.

  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 SmartEngage connector tile, then select the credential that will be used to connect to your SmartEngage account, and click Next; or, create a new SmartEngage 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 SmartEngage 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 Avatars

Retrieve avatars. Avatars are the brand identities in your SmartEngage account that subscribers, sequences, and other resources are associated with.

This endpoint returns the avatars available in your SmartEngage account. For detailed information about the response structure and available fields, see the SmartEngage API Reference.

[Rest API] List Tags

Retrieve tags. Tags are labels used to segment and organize subscribers in your SmartEngage account.

This endpoint returns the tags defined in your SmartEngage account. For detailed information about the response structure and available fields, see the SmartEngage API Reference.

[Rest API] List Custom Fields

Retrieve custom fields. Custom fields store additional subscriber attributes beyond the standard profile properties.

This endpoint returns the custom fields defined in your SmartEngage account. For detailed information about the response structure and available fields, see the SmartEngage API Reference.

[Rest API] List Sequences

Retrieve sequences. Sequences are the automated, multi-channel messaging flows configured in your SmartEngage account.

This endpoint returns the sequences defined in your SmartEngage account. For detailed information about the response structure and available fields, see the SmartEngage API Reference.

[Rest API] List Subscribers

Retrieve subscribers for a given avatar. Subscribers are the contacts in your SmartEngage account, unified across email, SMS, Messenger, and web push channels.

This endpoint returns subscribers for a given avatar. For detailed information about the response structure and available fields, see the SmartEngage API Reference.

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​

SmartEngage data sources can also be manually configured to ingest data from any valid SmartEngage 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 SmartEngage 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 SmartEngage destination, and select the Send to Destination option from the menu. Select the SmartEngage connector from the list of available destination connectors, then select the credential that will be used to connect to your SmartEngage account, and click Next; or, create a new SmartEngage 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 SmartEngage 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] Add Tag

Add a tag to a subscriber for a given avatar. Use this template to apply tags to subscribers based on records from a Nexset.

Each record from your Nexset is sent as a JSON request body to add a tag to a subscriber. The request body must include the fields required by the SmartEngage API. For detailed information about the request format and required fields, see the SmartEngage API Reference.

[Rest API] Remove Tag

Remove a tag from a subscriber for a given avatar. Use this template to remove tags from subscribers based on records from a Nexset.

Each record from your Nexset is sent as a JSON request body to remove a tag from a subscriber. The request body must include the fields required by the SmartEngage API. For detailed information about the request format and required fields, see the SmartEngage API Reference.

[Rest API] Remove From Sequence

Remove a subscriber from a sequence for a given avatar. Use this template to unsubscribe contacts from an automated sequence based on records from a Nexset.

Each record from your Nexset is sent as a JSON request body to remove a subscriber from a sequence. The request body must include the fields required by the SmartEngage API. For detailed information about the request format and required fields, see the SmartEngage API Reference.

[Rest API] Add Subscriber

Create a new subscriber for a given avatar. Use this template to add contacts to your SmartEngage account based on records from a Nexset.

Each record from your Nexset is sent as a JSON request body to create a new subscriber. The request body must include the fields required by the SmartEngage API. For detailed information about the request format and required fields, see the SmartEngage API Reference.

[Rest API] Create Custom Field

Create a new custom field for a given avatar. Use this template to define custom subscriber attributes based on records from a Nexset.

Each record from your Nexset is sent as a JSON request body to create a new custom field. The request body must include the fields required by the SmartEngage API. For detailed information about the request format and required fields, see the SmartEngage API Reference.

Manual configuration​

SmartEngage destinations can also be manually configured to send data to any valid SmartEngage 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 SmartEngage endpoint, open the destination resource menu, and select Activate.

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