Skip to content
Native integration

Pidgely for VTEX

For VTEX operations that send a lot of email and care where it lands: connect your account with an application key and Pidgely sends your order emails in your brand, from your own domain, with transactional and marketing traffic kept apart.

Connect your store

What the integration does

  • Connection by merchant-made credentials: your VTEX account name, an application key and its token, with nothing to install
  • The five order emails go out as the OMS order moves through its states, using an order hook registered on your account
  • Pidgely registers one order hook per application key and renews it during reconciliation, since VTEX lets a hook lapse after 3 days with no traffic
  • Customer e-mails are read from Master Data (the CL entity); where the key cannot read it, VTEX only provides its masked relay address
  • Several accounts, brands or B2B units can each connect, with their own verified domains and sender reputation

How to connect

  1. In the VTEX admin, under Account settings → Roles, create a role with View order, List Orders, Feed v3 and Hook Admin, Master Data read-only documents and a catalog read permission (Get Product and SKU)
  2. Under Account settings → Application keys, create a key and attach that role to it; copy the key and its token
  3. In Pidgely, open Stores, pick VTEX and paste the account name, key and token
  4. Pidgely checks them with one call to the orders API, stores them encrypted and begins a silent first sync
  5. Turn off the matching transactional messages on the VTEX side, so shoppers do not get duplicates

Good to know

Use a key made only for Pidgely: VTEX allows a single order hook per application key, so sharing it with another integration would replace that integration’s hook.

VTEX has no customer or product webhooks and its order list cannot filter by “updated since”, so every 6 hours Pidgely re-reads the orders created in the last 30 days and reads products one by one. Abandoned carts are not captured: VTEX exposes them only through the storefront orderForm, which would need a script on the store.

VTEX also has its own transactional tools. Pidgely suits teams that want deliverability under control; see order confirmation and shipping emails for what each should contain. Key setup is in the VTEX docs on application keys.

Frequently asked questions

Which permissions does the VTEX key need?

The role needs View order, List Orders, Feed v3 and Hook Admin, read-only access to Master Data documents, and a catalog read permission such as Get Product and SKU.

Why a dedicated key?

VTEX gives one order hook to each application key. A key shared with another tool would have its hook overwritten.

Do I install an app from the VTEX App Store?

No. The connection uses an application key you create in the admin, so there is nothing to install.

Why do some customer e-mails look masked?

VTEX shows its relay address when the key cannot read Master Data. Give the role read-only access to the CL entity and real e-mails come through.

How quickly do order emails go out?

When the order hook fires. If VTEX misses one, the reconciliation every 6 hours re-reads the last 30 days of orders and sends what is missing, once per order and kind.

Get started

Connect your VTEX store

Create a free account, verify your domain and connect the store. The first sync starts right away.

Create free account