How to Install the VTEX APP on Zendesk?

To install the Vtex app in your Zendesk, you need to access the Zendesk App Marketplace (https://www.zendesk.com/apps). In the search menu, look for "Vtex".

Clicking on install will open a tab where you should select the Zendesk where you want to install the VTEX App. Choose the Zendesk where you want to perform the installation.

Thus, completing the installation of your VTEX App.

How to Configure the VTEX APP on Zendesk

After installation, you will be directed to the configuration page of your app, where the following fields will be configured:

We have only 6 mandatory fields: Title, vtex_url, vtex_key, vtex_token, and vtex order custom field id. The other fields can be used according to your needs.

Title: this will be the name of your app installation.

vtex_url: URL of your Vtex API (The URL cannot contain HTTP). Example:

“webservice-johnscompany.vtexcommercestable.com.br”;

Display brand on ticket: true/false.

vtex_key: API key.

vtex_token: API token.

To configure the following fields, it is necessary to create a ticket field in Zendesk to associate with the fields of your Vtex.

Field creation:

Access the Admin tab of your Zendesk, locate the Manage group, Ticket Fields option, on the Ticket Fields screen,  new fields must be added:

IMPORTANT: for Vtex the field type must always be "Text" to avoid future issues.

vtex order custom field id: ID of the custom field previously created to store the VTEX order ID in tickets;

vtex order status: Zendesk custom field ID to store the status of the VTEX order;

vtex order customer_name: Zendesk custom field ID to store the name of the customer of the VTEX order;

vtex order customer_document: Zendesk custom field ID to store the customer document of the VTEX order;

vtex order customer_phone: Zendesk custom field ID to store the customer phone number of the VTEX order;

vtex order date: Zendesk custom field ID to store the date of the VTEX order;

vtex order description: Zendesk custom field ID to store the description of the VTEX order;

vtex order payment: Zendesk custom field ID to store the payment type of the VTEX order;

vtex order value: Zendesk custom field ID to store the value of the VTEX order;

vtex order transport_value: Zendesk custom field ID to store the transport value of the VTEX order;

vtex order transport_name: Zendesk custom field ID to store the transport name of the VTEX order;

vtex order state: Zendesk custom field ID to store the state of the VTEX order;

vtex order processing_date: Zendesk custom field ID to store the processing date of the VTEX order;

vtex order eletronic_receipt: Zendesk custom field ID to store the electronic receipt of the VTEX order;

vtex order delivery_date: Zendesk custom field ID to store the delivery date of the VTEX order;

vtex order total: Zendesk custom field ID to store the total value of the VTEX order;

fill_field: Zendesk custom field ID to inform if the tickets were filled by the application;

show_headlight: Field to define if the headlight is displayed (True to display and false to not display);

vtex order limit_change: Zendesk custom field ID to store the VTEX change limit date;

Parameter to define the language of the app (pt-br, es, en): Language must be the same as defined in Vtex;

Enable function restrictions: Define which users can access Vtex;

Activate group restrictions: Define which groups can access Vtex.