Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nekt.com/llms.txt

Use this file to discover all available pages before exploring further.

HelenaCRM is a Brazilian CRM and customer engagement platform that combines contact management, sales pipelines, and multi-channel messaging (WhatsApp, chat) for businesses managing customer relationships.

Configuring HelenaCRM as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the HelenaCRM option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

You’ll need to provide your HelenaCRM Bearer token. To generate it, go to Ajustes > Integrações > Integração via API in your HelenaCRM account. The following configurations are available:
  • API Key: Your HelenaCRM Bearer token (required).
  • Start Date: The earliest date from which records will be synced (advanced setting).
Once you’re done, click Next.

2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones. Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table, and the type of sync.
  • Layer: choose between the existing layers on your catalog.
  • Folder: a folder can be created inside the selected layer to group all tables.
  • Table name: a name is suggested, but feel free to customize it. You can add a prefix to all tables at once.
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: only new or updated data is fetched each run.
    • Full table: the current state of the data is fetched each run.
Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

Streams and Fields

Below you’ll find all available data streams from HelenaCRM and their corresponding fields:
FieldType
idstring
createdAtdatetime
updatedAtdatetime
companyIdstring
userIdstring
namestring
emailstring
phoneNumberstring
phoneNumberFormattedstring
profilestring
isOwnerboolean
availabilitystring
departmentsarray of objects
FieldType
idstring
createdAtdatetime
updatedAtdatetime
activeboolean
typestring
numberstring
numberFormattedstring
identityobject
FieldType
idstring
createdAtdatetime
updatedAtdatetime
companyIdstring
namestring
nameWhatsappstring
nameInstagramstring
nameMessengerstring
phoneNumberstring
phoneNumberFormattedstring
emailstring
instagramstring
messengerIdstring
annotationstring
tagIdsarray of strings
tagNamesarray of strings
statusstring
originstring
importedAtdatetime
utmstring (JSON)
customFieldsstring (JSON)
portfolioIdsarray of strings
portfolioNamesarray of strings
metadatastring (JSON)
FieldType
idstring
createdAtdatetime
updatedAtdatetime
parentIdstring
typestring
entityTypestring
scopeIdstring
companyIdstring
namestring
keystring
positioninteger
requiredboolean
visibleboolean
isValueRangeboolean
optionsstring (JSON)
childrenstring (JSON)
FieldType
idstring
companyIdstring
createdAtdatetime
updatedAtdatetime
namestring
isDefaultboolean
distribuitionEnabledboolean
restrictionTypestring
distributionConfigstring (JSON)
directLinksstring (JSON)
agentsarray of objects
channelsarray of objects
FieldType
limitHoursboolean
offlineResponsestring
timezoneDiffnumber
daysarray of objects
FieldType
idstring
namestring
descriptionstring
createdAtdatetime
updatedAtdatetime
FieldType
idstring
createdAtdatetime
updatedAtdatetime
namestring
bgColorstring
textColorstring
FieldType
idstring
createdAtdatetime
updatedAtdatetime
activeboolean
archivedboolean
channelIdstring
namestring
textstring
footerTextstring
statusstring
channelTypestring
typestring
paramsstring (JSON)
internalNamestring
fileTypestring
quickReplyAliasstring
rejectedDescriptionstring
categoryIdstring
categoryNamestring