For arlanix/notification 1.0.0

Glossary

Address

The one place a subscription sends to: an email address, a Telegram chat, or a Slack or Discord channel's webhook. A topic takes one subscription per address.

Bot

A Telegram account a program posts as. The store has one, set up in the settings; a subscription may have one of its own.

Condition

What a rule checks before it sends, such as Grand total equals or greater than 100. A rule with none sends every time its event happens.

Consumer

The background process that takes deliveries off the queue and sends them. The store's cron starts it.

Delivery

A message on its way to one subscription. It is queued, sent, tried again, failed or skipped.

Digest

One email, or one chat message, that carries the messages waiting for the same subscription, up to 25 different messages, the same message once with how many times it came.

Event

Something that happens in the store and that a rule can answer, such as a new order, a refund or a stopped cron. Each has fields: the order's number, its total, its customer.

Message

What is published to a topic: a subject, a text, a severity, a few facts, and which module or rule sent it.

Message Log

Every message published, with what became of it.

Personal data

A field about a person, such as a customer's email or an admin's IP address. A rule sends it only when its own text names it.

Publish

What a module or a rule does when something happens: it sends a message to a topic.

Queue

Where deliveries wait for the consumer, so whatever published never waits for the mail server, Telegram, Slack or Discord.

Rule

An event, its conditions and a topic: when the event happens and the conditions are met, a message goes to the topic.

Severity

How bad what a message reports is: Info, Warning or Error. A subscription takes everything, warnings and errors, or errors only.

Subscription

A topic's messages, to one address, by one way of delivery: email, Telegram, Slack or Discord.

Topic

What a message is about, such as Feed alerts. A rule sends to the topic it names.

Variable

An event's field, or one of the message's own, named in a rule's subject or body in braces: {order.increment_id}, {message.topic}.

Webhook

An address Slack or Discord makes for one channel: what is posted to it appears in the channel.