Skip to main content
Opa! Suite, by IXC Soft, is an omnichannel customer service platform: WhatsApp, Instagram, Facebook, Telegram, webchat and telephony in one queue of tickets (atendimentos), with attendants, virtual agents (bots), departments and satisfaction surveys. This connector reads your installation’s data through the Opa! Suite API and brings every ticket with its full history, the messages of each ticket, customers, contacts, users, departments, ticket reasons, tags, communication channels, message templates and service periods.
The connector only reads data. It never creates, changes or deletes anything in Opa! Suite.

Before you start

The connector uses the API token of an Opa! Suite user. You need the Grupos de permissão and Alterar permissões dos usuários permissions in Opa! Suite to set it up. We recommend a user only for this integration.
  1. Create an API permission group. In Opa! Suite, go to Configurações → Permissões and click Adicionar novo. Give it a name, turn on Grupo exclusivo para API and save. Open the group, go to the Permissões tab and mark Visualizar for the data you want to sync (see the table below). In a new API group every permission starts unmarked.
  2. Give the user API access. Go to Usuários, open the integration user and, in Cadastro → Permissões, click Editar informações. Turn on Possui acesso à API do sistema, choose the group you created in Grupo de permissões da API and save.
  3. Copy the token. The window Token API gerado com sucesso shows the token only once. Copy it before closing the window. If you lose it, click Gerar novo token in the same place (the previous token stops working at once).
  4. Find your Opa! Suite Address. It is the address you open in the browser, with https and nothing after the domain, for example https://yourcompany.opasuite.com.br.
If the API permission group restricts the allowed networks (Configurações → Permissões → the group → Preferências do grupo → Redes permitidas), add Nekt’s IP addresses to that list: 34.24.209.97, 34.74.81.117 and 34.138.230.39. These are the addresses of Nekt Express. If your Nekt workspace runs on your own cloud account (GCP or AWS), ask Nekt support for the addresses to allow. If your Opa! Suite runs on your own server, its firewall must also accept connections from these addresses.

Configuring Opa! Suite as a Source

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

1. Add account access

The following configurations are available:
  • Opa! Suite Address: the address of your installation, with https and nothing after the domain, for example https://yourcompany.opasuite.com.br. The address must be reachable from the internet.
  • API Token: the token of the integration user (see Before you start).
  • Start Date: the earliest ticket opening or closing date synced, for Tickets and Messages. The other tables are always read in full.
One source reads one Opa! Suite installation. If you have more than one, create one source for each, with its own address and token.
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.
Tip: The stream can be found more easily by typing its name.
Select only the tables your API permission group can read. A table without permission is skipped in every sync and shown as failed. 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 (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: keep the suggested type. Tickets and Messages are Incremental: each sync reads only the tickets opened or closed in the last days and merges them into the table. The other tables are Full table: Opa! Suite gives no change date for them, so each sync reads them whole and replaces the table.
Keep Messages as Incremental. As Full table, every sync would read the messages of every ticket since the Start Date again.
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. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). We recommend a daily sync. Each sync reads again the last 3 to 4 days of tickets, every ticket still open and their messages, all from your Opa! Suite server, so syncing more often than that adds load to your server without bringing much new data. Optionally, you can configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here. 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

Available streams

The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description. Join atendimentos.setor with departamentos.id, atendimentos.id_atendente with usuarios.id, atendimentos.id_user with contatos.id, atendimentos.id_cliente with clientes.id, atendimentos.canal_id with canais_comunicacao.id and mensagens.id_rota with atendimentos.id.

Fields by stream

Fields marked String (JSON) hold a nested object or list as JSON text; use your warehouse’s JSON functions to read them. Dates and times are in UTC. Every table also has an other_fields column (String, JSON) with any field Opa! Suite returned that has no column of its own; it is empty when every field is mapped.
Every ticket (atendimento) opened or closed since the Start Date.Table: atendimentos · Primary key: id · Sync: Incremental (last_activity_at)
The messages of each ticket.Table: mensagens · Primary key: id · Sync: Incremental (atendimento_last_activity_at)
Table: clientes · Primary key: id · Sync: Full table
Table: contatos · Primary key: id · Sync: Full table
Table: usuarios · Primary key: id · Sync: Full table
Table: departamentos · Primary key: id · Sync: Full table
Table: motivos · Primary key: id · Sync: Full table
Table: etiquetas · Primary key: id · Sync: Full table
Table: canais_comunicacao · Primary key: id · Sync: Full table
Table: templates · Primary key: id · Sync: Full table
Table: periodos_atendimento · Primary key: id · Sync: Full table

Implementation Notes

Data Quality Considerations

  • Tickets are read by opening and by closing date. Each sync reads the tickets opened or closed since the last sync (minus 2 days, to catch late updates). A ticket opened long ago comes back with its final state when it is closed.
  • Open tickets (waiting, in service or in satisfaction survey) are read again on every sync until they close, whatever their age (Opa! Suite lists open tickets of the last 365 days). All their messages are read again on every sync too, so new messages of an open ticket arrive with the next sync.
  • A change to a ticket that is already closed (for example, a rating given days later) is only picked up if it happens within 2 days of the ticket’s last activity read. A full sync brings every ticket up to date.
  • Tickets opened before the Start Date but closed after it are included.
  • Permissions: each table needs its permission in the API group (see Before you start). If the group cannot read a table, that table is skipped and not updated, the other tables keep syncing, and the sync log names the table and the permission to give.
  • Full table tables are never half updated. The connector reads all the data of a full table table before writing any of it. If Opa! Suite fails while it is read, nothing of that table is sent and the sync shows it as failed.
  • Tokens and passwords that the API may return for users are never stored.

API Limits & Performance

  • Opa! Suite does not publish a request limit, and the API runs on your installation’s server. The connector sends one request at a time, with a short pause between them, and waits when the server asks it to slow down.
  • Messages are read one ticket at a time: the first sync makes one request per ticket since the Start Date. Choose a Start Date that keeps the first sync manageable (for example, the last few months), and let later syncs keep the table up to date.
  • Tickets are read one week at a time. If Opa! Suite does not apply the date or status filters as documented, the Tickets or Messages table fails with a message, instead of loading an incomplete history.

Troubleshooting

Skills for agents

Download Opa! Suite skills file

Opa! Suite connector documentation as plain markdown, for use in AI agent contexts.