Custom Objects

Introduction

Custom Objects are structures defined to store various information within a contact. The same contact can contain any number of Custom Objects, which can be created through automations or manually.

Examples of possible Custom Objects:

• Feedbacks: support ticket ID, feedback message (optional) and service rating.

• Order: order ID, order name and unit price.

• Requested Exams: type of exam, scheduling date, laboratory.

• Event Participations: event name, date, attendance confirmed, notes.

• Internal Trainings: training name, workload, date, completion (yes/no).

Creating a Custom Object definition

Go to the Settings, and then to Custom Objects. After that, click the Newbutton to create a new definition.

The value entered in the field Name (Plural) will be displayed as a new tab on the profile of all contacts, representing a list of linked objects. For a Custom Object to be available in the instance, you must check the option Published.

If you want to allow automatic creation of these objects via chatbots, automations, integrated webhooks, or through the contacts page itself, also enable the option Allow dynamic creation of objects.

Settings Menu.

Definitions list.

Edit Definition screen.

Field Settings

When creating a new field for a Custom Object definition, you must select the data type, such as Text, Number, Date, among others — as listed in the image below.

Each field can have some additional settings:

• Required: Requires the field to be filled in when creating or editing the custom object.

• Unique Identifier: Defines whether the field value will be unique for each object, functioning as a unique identifier (useful for cases like order IDs, protocol codes, etc.).

• Default Value: Value that will be automatically filled in when creating a new object, and can be changed manually if necessary.

• Alias: Defines how the field will be referenced in other parts of the system, such as when using tokens. See more about custom object tokens.

List of field types.

Field edit screen.

Filling a Object Manually

When accessing a lead's full data, you will be able to view the Event Participationstab, where the custom objects associated with it are listed.

You can link an existing custom object to a lead — ideal, for example, in cases of fixed subscription plans, where you just need to link to the lead without creating a new object from scratch. However, in this example, we will choose to create a new custom object.

Once created, the object will automatically appear in the lead's Event Participations tab. These data can be used in tokens (for message personalizations, for example) or queried via automations, as needed.

Contact full data.

Filling an object.

Event registered.