Documentation
Feedback
Guides
App Development

App Development
Node apps
Handling events
Receiving Order Notifications
Receiving Order Notifications

Recipe

  1. Choose a workspace on your account that you'll work on. Let's suppose we're using the workspace oms.
  2. Clone this repository https://github.com/vtex-apps/orders-feed-example
  3. Go to https://{accountName}.myvtex.com/admin/apps/vtex.orders-broadcast/setup
  4. Change the Target Workspace variable to the name of the workspace you have created previously.
  5. Now you can link this app (vtex.orders-feed-example) in your desired workspace and receive order status updates.
  6. Now, if you finish an order on the account's Store, you'll see the notifications pop up on the console. You can start your development extracting the listener code from the cloned app to your application.
  7. If you want more details check out the readme on the example app

Example running on account cliqueretire and workspace lucis:

{"base64":"  ","img":{"width":2880,"height":1658,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":460244,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/how-to-receive-order-notifications-on-vtex-io-0.png"}}

Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
1
Photo of the contributor
+ 1 contributors
On this page