Sources

To allow an application to read and/or write data in a node, a Source must be defined. This provides the application with access permissions through the use of an authorization token when the application attempts to interact with the data contained in one or more nodes.

On the Settings > Customers > Sources page, you can:

• View enabled and disabled sources.
• Create and configure sources.
• Modify sources.
• Delete a source.

Creating a new source

On the platform, select Settings > Customers > Sources > Create new source from the side menu.

Providers are the mechanisms used to interact with the data. The reading and/or writing capability of an application is determined by the type of Provider associated with the source. The currently available providers are:

• Contacthub API
• Javascript Wwbsite
• Contactplan
• Contactsend
• Java SDK

Each provider has its own level of security:

• Trusted: read/write access.
• Untrusted: write access only.

Providers are generally considered trusted when they have a high level of security in the permissions granted by the tokens. During the creation of a new source, each available provider is shown with its associated and recognized security level.

After selecting the desired provider, in the Active Nodes section, choose the nodes you want the application to access.

The provider may also have additional properties. For example, the JavaScript provider requires the URL of all domains authorized to write to the node(s), while the Contacthub API provider allows defining the IP address that can read and write data in the node.

Upon saving the new source, an authorization token is generated. The token can always be retrieved from the individual source tab, Settings > Customers > Sources, by clicking on the desired source. On this page, a new token can be created by selecting Regenerate.

Creating the Contacthub API dource

To use the token directly with an API call, create a source set for Contacthub API.

The information to be entered includes:

• Name and Description.
• Node where the source can read and/or write.
• Provider Options > the list of IP addresses ranges allowed to read and write a given source, where you can enter one or more authorized IP ranges to read and/or write data.

The API documentation is available here.

warning

Each API call can have content (customer or events) with a maximum size of 64kb.

Creating the JavaScript website source

To add JavaScript to a website and track all customer actions, you need to create a JavaScript Website source.

The information to be entered includes:

• Name and Description.
• Node where the source can read and/or write.
• Provider Options, where you specify the URLs that can write to the source.

When creating a JavaScript source, a token is provided to use during the JavaScript integration.

JavaScript documentation for a site is available in the Data Model chapter.

Creating the Contactplan source

This source allows synchronizing most customer events with the Segments module (Contactplan) and associating extended properties with the appropriate field. For more information, see the Data Model chapter.

The information to be entered includes:

• Name and Description.
• Node, where the source can read and/or write.
• Provider Options:
  • Choose the appropriate tenant from the Select a Tenant list.
  • In Classifications, enter the names of the appropriate purchase event key and value pairs that you want to export to the Segments module (Contactplan). You can export up to 15 classifications (up to 10 in string format and 5 in date format). More information on classifications is available here.
• In Map event's extended properties to Plan fields, proceed as follows:

  • Select an event category from the Segments module (Contactplan), such as Purchases, and map the listed extended properties to the appropriate Segments fields.

    This option allows the use of extended customer properties for segmentation purposes.

warning

After configuring the necessary mappings and completing the creation of the source, you must make the related fields visible in the Segments area and, for example, update the displayed names as needed. More details are available here.

Limitations

You can create a Contactplan source for a specific tenant only if there is already a Send synchronization for the database used by the tenant.

The following limitations are necessary to ensure data integrity and consistency across the platform. The limitations are based on the principle "one source : one node : one userdb."

• Only one Contactplan source can be created per node.
• A userdb can be synchronized with only one node with a Contactplan source.
• A Contactplan source can be created on a node only if there is a configured Send source on the same node, and both are synchronized with the same node.

Creating the Contactsend source

The Customers area is natively integrated with Send, allowing you to automatically synchronize customer data and newsletter subscriptions almost in real-time.

To activate this source, fill out the following fields:

• Name and Description.
• Node where the source can read and/or write.
• Provider Options, enter here:
  • the grouppk, which is the identifier of the Send platform to be synchronized;
  • the userdb, which is the identifier of the Send database.

Additionally, by clicking Show additional fields:

• A list of customer profile fields appears, each with its own dropdown menu according to the selected Send database.
• Select the desired Send fields to activate data synchronization. You must select one or more paired fields.

In addition to customer data, you can synchronize one or more newsletter subscriptions. To activate the synchronization, in the subscription synchronization panel:

• Select the ID of the subscription system from the Customers area.

• Select the Send subscription system.

• Enter the Webform Code for the Send subscription system.

• If you want to add another subscription, click + located to the right of the Webform Code.

  

info

Subscription synchronization fields are not available for aggregated nodes.

Subscription synchronization is bidirectional. This means that any changes made in the Customer area and/or Send are synchronized.

Edit a source

To edit a source, go to Settings > Customers > Sources and enter the tab of the source to be modified. Once displayed, access the Configuration tab.

You can modify:

• The Source Name.
• The Description.
• The nodes to which the application can access.
• The provider's additional properties.

Click Update to save the changes.

Selecting the Back to list button cancels the source modification process in progress.

Selecting the Delete button removes the source after confirmation.

Deleting a source

To remove a source, proceed as follows:

1. Locate and click on the source to be removed.
2. Click Delete.
   • A notification message is displayed.
3. Click Confirm to delete the source.
   • The source is deleted.

Alternatively, after selecting the source, go to the Configuration tab, click Delete, and confirm the action.

danger

The removal action is irreversible and cannot be undone after confirmation.