Skip to content

The modules allow you to track, create, update, and delete a customer event and customers in your account.

Getting Started with


  • A account

In order to use with Ibexa Connect, it is necessary to have a account. If you do not have one, you can create a account at


The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting to Ibexa Connect

To connect your account to Ibexa Connect you need to obtain the Site ID and API Key from your account and insert it in the Create a connection dialog in the Ibexa Connect module.

  1. Log in to your account and open your Dashboard.

  2. Click Integrations > API .


  3. Copy the Site ID and API Key to your clipboard.


  4. Go to Ibexa Connect and open the module's Create a connection dialog.


  5. In the Connection name field, enter a name for the connection.

  6. In the Site ID and Secret API Key fields, enter the Site ID and secret API key copied in step 3 respectively. Click Continue.

The connection has been established.


Track a Customer Event

Tracks a new customer event.

Customer ID Enter the Customer ID whose events you want to track.
Event Name Enter the event name which you want to track.
Event Type Enter the event type. For example, to view the page events, enter page.
Data Enter the custom data to include with the event. For example, products, attachments.

Create or Update a Customer

Creates a new customer or updates the existing one.

Customer ID Enter the Customer ID for the new customer or the existing customer you want to update.
Email Enter the email address of the customer.
Created At Enter the ID at which the customer is created.

Add People to Segment

Adds people to a manual segment.

Segment ID Enter the Segment ID to which you want to add the people.
Customer IDs Add the Customer IDs you want to add to the Segment ID.

Make an API Call

Performs an arbitrary authorized API call.


Select the domain whose API calls you are making:

  • api

  • beta-api

  • track


Enter a path relative to https://<api|beta-api|track> For example: /v1/api/cusotmers

For the list of available endpoints, refer to the API Documentation.


Select the HTTP method you want to use:


to retrieve information for an entry.


to create a new entry.


to update/replace an existing entry.


to make a partial entry update.


to delete an entry.


Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.


Enter the body content for your API call.

Example of Use - List Customers

The following API call returns all tasks from your account:






Matches of the search can be found in the module's Output under Bundle > Body > results.

In our example, 5 were returned:


Delete a Customer

Deletes a customer and all their information from

Customer ID Enter the Customer ID you want to delete.