[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides sending emails with triggers on master data v2 in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2)

Schemas

Triggers

[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)

[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/trigger-ab-test)

[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)

[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)

[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)

[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)

[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)

[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v1)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2)

Schemas

Triggers

[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)

[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/trigger-ab-test)

[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)

[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)

[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)

[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)

[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)

[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v1)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides)

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/master-data-v2)

Triggers

[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)

Sending emails with triggers on Master Data v2

There are two ways of sending emails automatically with Master Data v2 triggers:

* [Sending emails](#sending-emails)
* [Sending emails using Message Center templates](#sending-emails-using-message-center-templates)

> Learn more about triggers in the article [Setting up triggers in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2).

## Sending emails

This is the more direct method of sending emails with Master Data v2 triggers, but without the standardization provided by [Message Center templates](#sending-emails-using-message-center-templates).

### Properties

| Field    | Type             | Description                                                                         | Required |
| -------- | ---------------- | ----------------------------------------------------------------------------------- | -------- |
| type     | String           | Action type, which must be email.                                                   | True     |
| provider | String           | Message Center provider name (usually named as default).                            | True     |
| from     | Object           | Information about the sender.                                                       | True     |
| ↪ email  | String           | Sender email.                                                                       | True     |
| ↪ name   | String           | Sender name.                                                                        | True     |
| to       | Array of strings | List of recipient email addresses, separated by comma.                              | True     |
| replyTo  | Array            | Email address for replies.                                                          | True     |
| subject  | String           | Email subject.                                                                      | True     |
| body     | String           | Email message body.                                                                 | True     |
| bcc      | Array of strings | List of email addresses that will receive a blind carbon copy (BCC) of the message. | False    |

### Dynamic expressions

You can use dynamic expressions to deal with document properties in these settings. For more information, look at the [Article on dynamic expressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-dynamic-expressions-on-master-data-v2).

### JSON schema example

`1

 {

2

 "properties": { ... },

3

 "v-triggers": [

4

 {

5

 "type": "email",

6

 "provider": "default",

7

 "subject": "Sending email with VTEX Master Data",

8

 "from": {

9

 "email": "mailfrom@email.com",

10

 "name": "My custom name"

11

 },

12

 "to": [ "test@test.com" ],

13

 "bcc": [ "testbcc@test.com" ],

14

 "replyTo": "noreply@email.com",

15

 "body": "VTEX Master Data Triggers email body"

16

 }

17

 ]

18

 }

`

## Sending emails using Message Center templates

See below how to set up a trigger to send emails using a [Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials%5F84) template.

### Properties

| Field    | Type             | Description                                                                         | Required |
| -------- | ---------------- | ----------------------------------------------------------------------------------- | -------- |
| type     | String           | Action type, which must be t-email.                                                 | True     |
| template | String           | Name of the Message Center template.                                                | True     |
| provider | String           | Message Center provider name (usually named as default).                            | True     |
| from     | Object           | Information about the sender.                                                       | True     |
| ↪ email  | String           | Sender email.                                                                       | True     |
| ↪ name   | String           | Sender name.                                                                        | True     |
| to       | Array of strings | List of recipient email addresses, separated by comma.                              | True     |
| replyTo  | String           | Email address for replies.                                                          | True     |
| subject  | String           | Email subjec.t                                                                      | True     |
| body     | String           | Email message body.                                                                 | True     |
| bcc      | Array of strings | List of email addresses that will receive a blind carbon copy (BCC) of the message. | False    |

### JSON schema example

`1

 {

2

 "properties": { ... },

3

 "v-triggers" [

4

 {

5

 "type": "t-email",

6

 "template": "template-name",

7

 "provider": "default",

8

 "subject": "My template email with VTEX Master Data",

9

 "to": [

10

 "{!email}",

11

 "test@email.com"

12

 ],

13

 "bcc": [

14

 "myemail@test.com"

15

 ],

16

 "replyTo": "noreply@company.com",

17

 "body": {

18

 "firstName": "{firstName}",

19

 "email": "{email}",

20

 "id": "{!id}",

21

 "clientName": "{!clientProfileData.firstName{!clientProfileData.lastName}",

22

 "ownerListName": "{!customData.customApps[0fields.ownerListName}",

23

 "ownerListEmail": "{!customData.customApps[0fields.ownerListEmail}",

24

 "items": "{!items}",

25

 "openTextField": "{!openTextField.value}"

26

 }

27

 }

28

 ]

29

 }

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/sending-emails-with-triggers-on-master-data-v2.md)

[A/B testing Master Data v2 trigger actions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2//docs/guides/trigger-ab-test)[Master Data v2 document saving flowNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2//docs/guides/master-data-v2-document-saving-flow)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

ON THIS PAGE

[Sending emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23sending-emails)

[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23properties)[Dynamic expressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23dynamic-expressions)[JSON schema example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23json-schema-example)

[Sending emails using Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23sending-emails-using-message-center-templates)

[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23properties)[JSON schema example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23json-schema-example)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/sending-emails-with-triggers-on-master-data-v2.md)

Copy page

On this page

ON THIS PAGE

[Sending emails](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23sending-emails)

[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23properties)[Dynamic expressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23dynamic-expressions)[JSON schema example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23json-schema-example)

[Sending emails using Message Center templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23sending-emails-using-message-center-templates)

[Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23properties)[JSON schema example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sending-emails-with-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2%23json-schema-example)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] How do I use the VTEX overlay layout app? Provide documentation and configuration details.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/layout-apps)

[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.condition-layout)

[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.disclosure-layout)

[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.flex-layout)

[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.modal-layout)

[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout)

[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.responsive-layout)

[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.slider-layout)

[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.stack-layout)

[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.sticky-layout)

[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.tab-layout)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/layout-apps)

[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.condition-layout)

[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.disclosure-layout)

[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.flex-layout)

[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.modal-layout)

[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout)

[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.responsive-layout)

[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.slider-layout)

[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.stack-layout)

[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.sticky-layout)

[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.tab-layout)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/vtex-io-apps)

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/guides/layout-apps)

Overlay Layout

Official extension

Version: 0.1.3

Latest version: 0.1.3

[![{"base64":"  ","img":{"width":110,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

The Overlay Layout app provides blocks that help you create a Dropdown, Select or a Tooltip component.

![{"base64":"  ","img":{"width":935,"height":310,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":126013,"url":"https://user-images.githubusercontent.com/52087100/78159134-881f2100-7418-11ea-94e1-d70343cd021f.gif"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/52087100/78159134-881f2100-7418-11ea-94e1-d70343cd021f.gif)

_Example of a [Locale Switcher](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/all/vtex.locale-switcher@0.5.5) using the Overlay Layout_.

## Configuration

1. Add the Overlay Layout app to your theme's dependencies in the `manifest.json`, for example:

`1

{

2

 "dependencies": {

3

 "vtex.overlay-layout": "0.x"

4

 }

5

}

`

Now you can use the two blocks exported by the app:

| Block name      | Description                                                                                |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| overlay-trigger | ![{"base64":"  ","img":{"width":69,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/-Mandatory-red"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Mandatory-red) Declares a renderable children block responsible for triggering the overlay-layout content. |
| overlay-layout  | ![{"base64":"  ","img":{"width":69,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/-Mandatory-red"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Mandatory-red) Declares a renderable children block responsible for building the                           |

1. In any desired theme template, add the `overlay-trigger` and then declare it using a block of your choosing and the `overlay-layout`:

`1

{

2

 "overlay-trigger": {

3

 "children": [

4

 "rich-text#question",

5

 "overlay-layout"

6

 ]

7

 },

`

_Notice that the_ `overlay-trigger` i_s not rendered. Following the example stated above, the_ `rich-text` _block will be the one rendered and responsible for effectively triggering the Overlay Layout content (defined by the children block of_ `overlay-layout`_)._

### `overlay-trigger` props

| Prop name | Type | Description                                                                          | Default value |
| --------- | ---- | ------------------------------------------------------------------------------------ | ------------- |
| trigger   | Enum | Defines whether the popover-layout will be opened by click (click) or hover (hover). | click         |

1. Configure the chosen trigger [block](https://read.calvincode.net/reader?url=https://vtex.io/docs/apps/all) and declare the `overlay-layout` using its props. For example:

`1

 "rich-text#question": {

2

 "props": {

3

 "text": "**Click to open the Overlay Layout**",

4

 "blockClass": "question"

5

 }

6

 },

7

 "overlay-layout": {

8

 "props": {

9

 "placement": "left"

10

 },

11

 "children": [

12

 "rich-text#link"

13

 ]

14

 },

15

 "rich-text#link": {

16

 "props": {

17

 "text": "\n**Reach us at**\nwww.vtex.com.br",

18

 "blockClass": "link"

19

 }

20

 }

21

}

`

_The_ `overlay-layout` _defines which block will be rendered in order to build the Overlay Layout content. This means that you will have to pass to it a children block to be rendered._

### `overlay-layout` props

| Prop name      | Type    | Description                                                                                | Default value                |
| -------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| placement      | Enum    | Defines the Overlay Layout content placement when it is triggered according to the Trigger component positioning. Possible values are: bottom, left, right or top. If there is no page space in the placement that you choose, it will fit in a fallback position.                                          | bottom                       |
| scrollBehavior | Enum    | Defines the Overlay Layout content behavior when users try to scroll the page. Possible values are: lock-page-scroll (in which users can't scroll), close-on-scroll (the block is closed when users start scrolling) or default (Scroll does not affect the Overlay Layout content).                        | default                      |
| backdrop       | Enum    | Once the Overlay Layout content is rendered, it defines whether a backdrop overlay will be displayed (visible) or not (none). When set as visible, the backdrop will close Overlay Layout content when clicked on. Otherwise, the content will be closed only if any component from the page is clicked on. | none                         |
| showArrow      | Boolean | Whether an arrow pointing to the overlay-trigger component should be displayed on UI(true) or not (false).                                                                                | false                        |
| offsets        | Object  | Defines the overlay-layout component positioning when compared to the overlay-trigger (unit used is px). For more details, check out the offsets object table stated below.                                                                                | { skidding: 0, distance: 0 } |

* **`offsets` object:**

| Prop     | Type   | Description                                                                                |
| -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| skidding | Number | Defines the overlay-layout component positioning side by side with the overlay-trigger.                                                                                |
| distance | Number | Defines the distance between the overlay-layout and the overlay-trigger components in the UI. A positive number places the overlay-layout component farther, while a negative number lets it overlap the overlay-trigger. |

## Customization

In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).

| CSS Handles         |
| ------------------- |
| arrow               |
| container           |
| outsideClickHandler |
| paper               |
| popper              |
| popperArrow         |
| trigger             |

[Modal Layout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.modal-layout)[Responsive LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.responsive-layout)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout%23configuration)

[overlay-trigger props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout%23overlay-trigger-props)[overlay-layout props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout%23overlay-layout-props)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.overlay-layout/docs/apps/vtex.overlay-layout%23customization)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore go live overview in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview)

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-before-you-begin)

[1\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-1-configuring-external-dns)

[2\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-2-integrating-the-vtex-login)

[3\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)

[4\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview)

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-before-you-begin)

[1\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-1-configuring-external-dns)

[2\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-2-integrating-the-vtex-login)

[3\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)

[4\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore)

Go live overview

In a headless architecture, an ecommerce website relies on the seamless collaboration of various modules. FastStore specializes in the frontend aspect, enabling the development of high-performance user interfaces for ecommerce websites. However, to create a complete digital commerce experience, multiple core modules must be integrated. At **VTEX**, some of these modules are:

| Module                      | Description                                                                                |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| **Checkout**                | Receives the shopper's information necessary to process an order.                                                                               |
| **OrderPlaced**             | Handles the processing of customer orders. It displays a successful message right after the checkout process is completed.                      |
| **Login**                   | Handles user login in a store.                                                                                |
| **MyAccount**               | Allows customers to manage their orders and personal data (e.g., profile information, passwords, addresses, and credit cards) on a single page. |
| **VTEX Intelligent Search** | Provides autocomplete and displays relevant results based on the store catalog.                                                                 |

Therefore, to provide shoppers with a full checkout and post-purchase experience, you, as a developer, must guarantee the integration between your FastStore project and VTEX solutions before going live.

To ensure that you have set up all configurations for your store to run smoothly, please consider the following go-live checklist.

> To get a complete overview of the go-live process for any VTEX store, see this [Go-live guide](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/go-live-your-store--4Ns5FxIiksmjsdX2yOTduM/1iP90RcJvlrfQhnlxM54wo).

---

## Go-live checklist

### Storefront development

Checking the account edition

Ensure that your account edition is set to `vtex.edition-store@5.x` Edition app in your master workspace.

| Management              | Reference                                                                                |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Agency and VTEX Support | If your account uses a different Edition App version, [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) requesting the installation of the [vtex.edition-store@5.x](mailto:vtex.edition-store@5.x). |

Deploying with FastStore WebOps

Deploy your project using the FastStore WebOps app.

| Management | Reference                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------ |
| Agency     | [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) |

Setting up the project

Set up and develop your Storefront.

| Management | Reference                                                                                |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Agency     | [Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project) |

### VTEX integration

Configuring external DNS for a custom domain

Configure your website's domain and subdomain.

| Management              | Reference                                                                                |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Agency and VTEX Support | [Configuring external DNS for a custom domain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns) |

Integrating the VTEX Login

Integrate the VTEX Login with your FastStore project.

| Management              | Reference                                                                                |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------- |
| Agency and VTEX Support | [Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-2-integrating-the-vtex-login) |

Integrating the VTEX Checkout

Adjust the header by replacing the links to the Checkout and MyAccount pages with the proper paths.

| Management              | Reference                                                                                |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Agency and VTEX Support | [Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout) |

Integrating the VTEX Order Placed and My Account

Clone, edit, and install the [faststore-vtex-integrations](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore-vtex-integrations/) app on your VTEX account.

| Management              | Reference                                                                                |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Agency and VTEX Support | [Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account) |

Checking the pages in the secure domain

Test your website links to pages being rendered in the secure subdomain, such as the Login, Checkout, My Account, and Order Placed pages.

**Management**: Agency

### Headless customization

Integrating the storefront with VTEX Headless CMS

Set up the preview flow between the storefront and the Headless CMS

| Management | Reference                                                                                |
| ---------- | -------------------------------------------------------------------------------------------- |
| Agency     | [VTEX Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) |

### SSL Configuration

Checking the pages SSL certificate

Check if all pages of your store have the correct SSL certificate configured.

**Management:** Agency

### Testing and performance

Performing Lighthouse audits

Run Lighthouse audits on your store's pages to guarantee you are going live with great performance

**Management:** Agency

* Run Lighthouse audits on your store's Home Page, Product Listing Page (PLP), Product Details Page (PDP), and custom pages.
* All pages must have Lighthouse Score equal or more than 60 on mobile devices.
* Any publication will be automatically blocked by the system until all checks pass.
* For more information about store performance, refer to the [Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview) track and the [Lighthouse Integration on WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23integrations) guide.

Setting up Traffic Splitting

If you already have a live store, configure traffic splitting to validate which version of your website is the best for your business needs.

**Management:** VTEX Support

### Analytics

Managing the Analytics module

Make sure that all analytics events and data are accurately being send to Google Analytics.

| Management | Reference                                                                                |
| ---------- | ------------------------------------------------------------------------------------------- |
| Agency     | [FastStore Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview) |

---

## Next

Before starting the go-live process, make sure that you have met all the necessary prerequisites listed on the [Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin) page.

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/overview.mdx)

[Validating UTM tracking in FastStore« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)[Before you beginNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-before-you-begin)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

ON THIS PAGE

[Go-live checklist](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23go-live-checklist)

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23storefront-development)[VTEX integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23vtex-integration)[Headless customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23headless-customization)[SSL Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23ssl-configuration)[Testing and performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23testing-and-performance)[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23analytics)

[Next](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23next)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/overview.mdx)

Copy page

On this page

ON THIS PAGE

[Go-live checklist](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23go-live-checklist)

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23storefront-development)[VTEX integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23vtex-integration)[Headless customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23headless-customization)[SSL Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23ssl-configuration)[Testing and performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23testing-and-performance)[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23analytics)

[Next](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-overview/docs/guides/faststore/go-live-overview%23next)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides setting up triggers on master data v2 in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2)

Schemas

Triggers

[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)

[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/trigger-ab-test)

[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)

[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)

[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)

[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)

[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)

[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v1)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2)

Schemas

Triggers

[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)

[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/trigger-ab-test)

[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/sending-emails-with-triggers-on-master-data-v2)

[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2-document-saving-flow)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)

[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)

[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)

[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)

[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v1)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides)

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/master-data-v2)

Triggers

[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2)

Setting up triggers on Master Data v2

Learn how to create and configure triggers in Master Data v2 to automate actions after a document update.

This guide will teach you how to create and configure triggers in **Master Data v2** to automate actions after a document update.

A **Master Data** trigger is an [action](#action) executed immediately after a document is inserted or updated.

**Master Data v2** supports the following types of triggers:

* Send an HTTP request.
* Send an email.
* Send email using [Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials%5F84) template.
* Save data to another data entity.

> This article is about **Master Data v2** triggers. If you want to use **Master Data v1**, check the [How to create a trigger in **Master Data v1**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-trigger-in-master-data--tutorials%5F1270) guide.

## Before you begin

You may use **Master Data v2** triggers to create and add hooks to VTEX first-party apps. To do that, [Create a new JSON schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) for the data entity used by the app and then follow the instructions below.

## Instructions

Each trigger is described as an item of the array `v-triggers` of a [JSON schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/master-data-schema-lifecycle). If you want to create a trigger for a data entity with no associated schema, you may [create a new schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) with the trigger settings according to what is described below.

To create a new trigger in an existing schema, follow these steps:

1. [Get the schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/schemas/-schemaName-) associated with the data entity you wish to add a trigger to.
2. Copy the JSON schema from the response and create a new object in the `v-triggers` array, configuring its properties according to your desired behavior. See the [Trigger properties](#trigger-properties) and [Example](#trigger-example) sections for more information.
3. Send the edited schema as the body to the [Save schema by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) endpoint.

> To edit Master Data v2 triggers, follow the steps described above, editing the properties you wish instead of creating a new array item.

### Trigger Properties

| Property  | Type    | Description                                                                                |
| --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name      | string  | Trigger name, limited to 100 characters. Don't use blank spaces; only underscores (\_) or dashes (\-) are allowed.                                                                                |
| active    | boolean | Defines whether the trigger is enabled (true) or disabled (false).                                                                                |
| condition | string  | A rule that validates the document before executing the trigger. See the [condition](#condition) section for more information.                                                                                |
| runAt     | object  | The scheduled date to execute the action. See the [runAt](#runat) section for more information.                                                                                |
| weight    | integer | Percentage value used for A/B testing. See the [Setting up an A/B test with Master Data trigger](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-a-b-test--4xFzBMHYty6gmEosWGWMC0) article for more information. |
| retry     | object  | Defines the retry policy, specifying the number of attempts and delay between them. See the [retry](#retry) section for more information.                                                                     |
| action    | object  | The action that will be executed. See the [action](#action) section for more information.                                                                                |

#### Condition

Setting up condition rules is very similar to using query parameters when making a call to Master Data API v2's [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search). However, differently from the API, you should not include `_where` in the `condition` string. Examples: `status=ready-for-handling`, `createdIn between 2001-01-01 AND 2016-01-01`, `email=my@email.com`.

You can create conditions based on any value of any field, including nested fields up to the second level, as exemplified below.

`1

 "condition": "Body.ChildOne.ChildTwo=Foo",

`

To get further information, check the [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/search) endpoint reference.

#### runAt

To schedule an action in the future, use the `runAt` object, with the `dateTime` and `increment` properties.

Set the `dateTime` string according to your specific need:

* To consider the date and time of the trigger as the start date, use `now` as the value.
* To consider the date and time of a specific field, use `{!fieldName}` as the value. E.g. `{!createdIn}`

Use one of the following `increment` object properties (integers) according to the time unit to be used:

* Minutes: `addMinutes`
* Hours: `addHours`
* Days: `addDays`
* Months: `addMonths`
* Years: `addYears`

See examples below:

* Schedule the execution 10 minutes later.

`1

 {

2

 "dateTime": "now",

3

 "increment": {

4

 "addMinutes": 10

5

 }

6

 }

`

* Schedule the execution six months after the field value `createdIn`.

`1

 {

2

 "dateTime": "{!createdIn}",

3

 "increment": {

4

 "addMonths": 6

5

 }

6

 }

`

#### Retry

By default, VTEX Master Data makes three attempts in an interval of 10 minutes. Use this property to override such behavior. See the example below of five attempts in an interval of 30 minutes.

`1

 {

2

 "times": 5,

3

 "delay": {

4

 "addMinutes": 30

5

 }

6

 }

`

#### Action

Define the action to be executed, which can be one of the following types:

Call an HTTP request

`1

 {

2

 "type": "http",

3

 "uri": "http://mydomain.com/api/test",

4

 "method": "POST",

5

 "headers": {

6

 "content-type": "application/json"

7

 },

8

 "body": {

9

 "id": "{!id}",

10

 "test": "TestValue",

11

 "count": 25

12

 }

13

 }

`

Send an email

`1

{

2

 "type": "email",

3

 "provider": "default",

4

 "subject": "My email with VTEX Master Data",

5

 "to": [

6

 "{!email}",

7

 "test@email.com"

8

 ],

9

 "bcc": [

10

 "myemail@test.com"

11

 ],

12

 "replyTo": "noreply@company.com",

13

 "body": "My email with document {!id}."

14

}

`

Send an email action using a [Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials%5F84) template.

`1

 {

2

 "type": "t-email",

3

 "template": "template-name",

4

 "provider": "default",

5

 "subject": "My template email with VTEX Master Data",

6

 "to": [

7

 "{!email}",

8

 "test@email.com"

9

 ],

10

 "bcc": [

11

 "myemail@test.com"

12

 ],

13

 "replyTo": "noreply@company.com",

14

 "body": {

15

 "firstName": "{firstName}",

16

 "email": "{email}",

17

 "id": "{!id}",

18

 "clientName": "{!clientProfileData.firstName} {!clientProfileData.lastName}",

19

 "ownerListName": "{!customData.customApps[0].fields.ownerListName}",

20

 "ownerListEmail": "{!customData.customApps[0].fields.ownerListEmail}",

21

 "items": "{!items}",

22

 "openTextField": "{!openTextField.value}"

23

 }

24

 }

`

Save a document to another data entity.

`1

 {

2

 "type": "save",

3

 "dataEntity": "copy",

4

 "json": {

5

 "id": "{!id}",

6

 "message": "{!message}",

7

 "custom": "created/updated by VTEX Master Data triggers"

8

 }

9

 }

`

### Trigger example

`1

{

2

 "properties": {},

3

 "v-triggers": [

4

 {

5

 "name": "copy-document",

6

 "active": true,

7

 "condition": "status=window-to-cancel",

8

 "action": {

9

 "type": "save",

10

 "dataEntity": "copy",

11

 "json": {

12

 "id": "{!id}",

13

 "message": "{!message}",

14

 "custom": "created/updated by VTEX triggers"

15

 }

16

 },

17

 "retry": {

18

 "times": 5,

19

 "delay": {

20

 "addMinutes": 30

21

 }

22

 }

23

 }

24

 ]

25

}

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/setting-up-triggers-on-master-data-v2.md)

[Working with JSON Schemas in Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2//docs/guides/working-with-json-schemas-in-master-data-v2)[A/B testing Master Data v2 trigger actionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2//docs/guides/trigger-ab-test)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23instructions)

[Trigger Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23trigger-properties)[Trigger example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23trigger-example)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/setting-up-triggers-on-master-data-v2.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23instructions)

[Trigger Properties](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23trigger-properties)[Trigger example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2/docs/guides/setting-up-triggers-on-master-data-v2%23trigger-example)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)