Integrations
VTEX

VTEX

People Answers Conversations

When you connect your VTEX Store to Infobip with our Exchange app, you can:

  • Sync your customer data to People so that you can use it in all Infobip products. For example, if you use Moments, you can use your VTEX contacts in campaigns and broadcasts
  • Connect your chatbots easily in VTEX for Answers by having the order, product, and customer information available for the chatbot to enhance the interaction
  • Create VTEX Context Cards in Conversations to enable a full shopping experience so that agents can access the relevant eCommerce data, such as orders and related customer details without navigating to another tab.

What you will need

Set Up Authentication

VTEX application keys

The My Keys page in VTEX lists all of the internal app keys. To access this page, go to Account settings > Account management > Application Keys and click on the Manage my keys button.

  • Label gives the purpose of the app key
  • Key contains the unique identifier for the app key
  • Status is a boolean value that indicates whether the app key is active or inactive
My Keys page showing app keys for VTEX

Generate a new application key

Application keys allow the external system to access your account, so your VTEX account must have this role: License Manager / Services access control / Save user.

  1. Click the Generate New button.
  2. In the Label field, enter the application key's purpose. This is optional. If you leave the field blank, it is set to the Key value of the generated key.
  3. Click Add roles to manage key permissions.
  4. Click Generate.
  5. Copy the Application Token and save it in a safe place. It is displayed only once.

Add the credentials to Infobip

  1. Log into Infobip and go to Exchange > VTEX.
  2. Click the Add button and accept the Exchange Terms & Conditions. Next, you see a configuration page.
  3. Select the Credentials tab and click Add Credentials.
  4. Enter the app key, the app token, and the base URI (for example: https://bestpartnerbr.myvtex.com/ (opens in a new tab) or bestpartnerbr).

Using VTEX in People

The last integration step is to map VTEX data fields to People.

  1. Logon to Infobip and go to Exchange > App Apps.
  2. Open the VTEX integration and select the Integrations tab.
  3. On VTEX Customers to People, click Configure to update the mappings.
  4. The left column displays your VTEX fields and the right column displays the available People fields. Map the fields you want to make available in People so they are available to other Infobip products.
Data mapping for VTEX to People

Using VTEX in Answers

You can make store owners' and customers' communication easy and automated by including the order, product, and customer information in the chatbot interaction with the Answers connection to VTEX. Let your customers use their favorite channel to buy directly from the VTEX store.

Example use-cases:

  • Providing product information
  • Providing order status information
  • Providing Customer information
  • Product Stock validation

Activate the Answers Block Card

Before using the block in Answers, you need to activate the integration:

  1. Log into Infobip and go to Exchange > All Apps > VTEX.
  2. Go to the Integrations tab.
  3. Click on the three dots over the VTEX Answers Block card.
  4. Select Activate.
  5. Choose the credentials you want to use.
  6. Click Save.

VTEX Answers block

You can find the VTEX block in the right-hand side panel under the Integrations section.

The VTEX block provides a set of functions that can be used in any journey Drag and drop the block on any part of the dialog where you need to use some function of the block.

Once the block is added in the dialog, choose the function you want from the drop-down list.

Each function has its own set of parameters in the request tab. For example, the GetCustomerByEmail function expects an email address as a parameter. The value is used to filter the VTEX customer database for a customer with that email address.

Most of the functions return data that are useful for the bot and/or the journey. The data retrieved from the function can be stored in Answers attributes using the Response tab. The data in transfer uses JSON format and in order to get the data you can use the dotted notation.

For example, the GetCustomerByEmail function returns the customer object from VTEX that contains all of the information stored there. If you'd like to store the customer's first name in an Answers attribute, refer to it as:

first_name or $.first_name

where the $ sign indicates the root of the JSON payload.

The functions available on the VTEX Answers Block are:

  • Get Customer by Email: Automate the customer search process for getting data in VTEX associated with a specific customer based on their email address.
  • Get Customer by ID: Automate the customer search process for getting data in VTEX associated with a specific customer based on their client ID.
  • Get Order by ID: Automate the order search process for getting information in real-time about a specific order in VTEX based on the order ID.
  • Get Orders for Customer: Automate the order search process for getting information in real-time about the order list of a specific customer.
  • Search for a Product: Automate the search of products available in your VTEX Store based on a keyword.
  • List Product Categories: Get the information of all product categories listed on your VTEX store.
  • Products In Category: Get the information of all products listed on a specific category in your VTEX store, based on the Category ID.
  • Get Product by SKU: Get the information of a specific product on your VTEX store, based on the SKU code.
  • Add item to cart: Add a new item to the cart checkout URL, where the user can then finish the order. Parameters needed are SKU of the product to be added, quantity, Seller ID, Answers Session ID and Temporal URL, which is optional and used when you are adding an item over an existing cart checkout URL. If you are adding the first item, Temporal URL can be empty.

Get order status in Answers Webhook

You can inform the user of their order number and status after they finish the checkout using the cart checkout URL created with the add item to cart function. To create the webhook:

  1. Create an order hook configuration in VTEX using the API: https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/hook/config (opens in a new tab). Use the following parameters:

    • type: FromWorkflow
    • status: You can select and include all status needed for your use case from the VTEX order status list, see the VTEX help order status details (opens in a new tab)
    • url in hook object: Contact your Infobip account manager to get the required endpoint
  2. Add a Webhook block in a dialog of your chatbot where you are expecting to receive the order status. An example of the JSON structure that you receive in the Webhook block is:

    json
     
        {
        
          "body": {
            "Domain": "Marketplace",
            "OrderId": "1337610500455-01",
            "State": "order-created",
            "LastState": "not-started",
            "LastChange": "2023-06-06T16:58:55.9988137Z",
            "CurrentChange": "2023-06-06T16:58:56.0883772Z",
            "Origin": {
              "Account": "YourAccount",
              "Key": "vtexappkey-youraccountKey"
        
            }
          } 
        }
     

Save the information you want to use in attributes and use them for sending a personalized message from your chatbot with the order status.

Using VTEX in Conversations

An agent using Conversations may wish to access some information from their VTEX platform to support communication with a client. They may need to access details about the history of the orders and any related customer details about the order. To use VTEX in Conversations, you use the VTEX Context Card. For more information about Context Cards, see Customer Context Card.

The VTEX Context Card supports the ability to:

  • View the full order history
  • View customer information for an order

When an agent is in conversation with a customer, the context cards on the right side of the Conversation Work panel can provide additional information or context that supports the customer conversation. You can find the VTEX in the context cards list.

Context cards in the Conversations panel are activated by default. This means that you see all the available context cards, even if you have not configured the fields.

If you have not set up the authentication and your preferred field values for the VTEX context card, you see a Configuration Pending message. Follow the instructions in Set up Authentication and configure the context card.

Activate the Context Card

Before using the VTEX Context Card, you need to activate it and configure the fields.

  1. Log into Infobip and go to Exchange > All Apps > VTEX.
  2. Go to the Integrations tab.
  3. Click on the three dots over the VTEX Conversations Block card.
  4. Select Activate.
  5. Choose the credentials you want to use.

Configure the Context Card

Use the Configuration page to define which details are available to the agent in the VTEX Context Card in Conversations.

  1. Go to the Integrations tab. VTEX Conversations Block
  2. Click Configure on the VTEX Conversations Block card. You see the Vtex Context Card fields. The left column displays the available VTEX fields. In the right column, you can enter a label that displays in the Context Card to represent the VTEX field. There are two tabs for Order information and Customer information. VTEX Configure Context Card
  3. Map the fields for order information.
    • Order card information - Define the most relevant order information available to the agent. You can select a maximum of three fields.
    • Order details information - Define the order details available to the agent. By default, it is mandatory to define three fields. To add more fields, click Add Field. To remove a field, click the X on the right.
  4. Map the fields for the Customer details information - Define the customer details available to the agent. By default, it is mandatory to define three fields. To add more fields, click Add Field. To remove the field, click the X on the right.
  5. Click Save to save the mappings.

Supported channels

The VTEX Context Card is supported in Conversations through the following channels:

  • Whatsapp
  • SMS
  • Voice
  • Viber
  • Email
  • Instagram Messaging
  • Facebook Messenger

Need assistance

Explore Infobip tutorials

Encountering issues

Contact our support

What's new? Check out

Release notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Service Terms & ConditionsPrivacy policyTerms of use