djkato/saleor-apps-redis_apl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
saleor-apps-redis_apl/apps/emails-and-messages/docs/introduction.md

2.2 KiB
Raw Blame History

Introduction

Glossary

  • Saleor API - instance of Saleor Shop
  • Saleor events - After events like creating new order or user registration Saleor API sends notification to EAM app with data describing it. When configuring the app, user can specify which events should send an email to the customers
  • EAM - Emails and Messages app
  • SMTP - Protocol used for sending emails
  • Sendgrid - Email sending service
  • Configuration - Group of settings related to one of the providers. User can specify many configurations.

How emails are sent?

Before any of the messages are sent, the application have to be installed and configured. After those steps are completed, application wait for the event to happen:

sequenceDiagram
    Saleor API ->>+ EAM App: Order created
    EAM App ->>+ EAM App: Choose active configuration based on event channel
    EAM App ->> EAM App: Choose event related settings
    EAM App ->> Provider API: Send email data
    Provider API ->> Customer: Deliver email
  1. Customer places order in the shop
  2. Saleor API notify the EAM App
  3. The application choose the configuration and send data provider (Sendgrid, SMTP, etc.)
  4. Provider delivers email to the customer

How configurations are determined

  1. Event webhook arrives to the app
  2. Get all configurations
  3. Filter out not active
  4. Filter out configurations not assigned to this channel:
    • If channel override option is not set, all channels are considered as assigned to this configurations
    • If channel override option is set and exclude channels are provided, filter out configuration if it's on this list
    • If channel override option is set and include channels are provided, filter out configuration if it's not on this list
  5. At this point we have active configurations which are intended to use with channel. Please note, at the same time multiple configurations/providers can be used for one event. Now we have to determine configuration assigned to payload event
  6. Check if event configuration is active
    • if it's active, use provided templates, etc and send the message
    • if it's not active, no message will be sent
  7. Now the application will send the message using chosen provider