About admin notifications #3371
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,17 +33,27 @@ | |
|
|
||
| ### Available notification types | ||
|
|
||
| Several built-in notification types are available. | ||
| TODO: Some/All are sent by various notifiers like event subscribers. | ||
|
Check failure on line 37 in docs/api/notification_channels.md
|
||
|
|
||
| | Notification type | Default recipients | | ||
| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| | ||
| | `Ibexa\AdminUi\Notifier\Notification\UserInvitation` | TODO: Given email address | | ||
| | `Ibexa\AdminUi\Notifier\Notification\UserPasswordReset` | TODO: Given email address | | ||
| | [`Ibexa\Contracts\FormBuilder\Notifications\FormSubmitted`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-FormBuilder-Notifications-FormSubmitted.html) | [Form submit email notification field](customize_email_notifications.md) | | ||
| | [`Ibexa\Contracts\Notifications\SystemNotification\SystemNotification`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Notifications-SystemNotification-SystemNotification.html) | TODO | | ||
| | [`Ibexa\Contracts\OrderManagement\Notification\OrderStatusChange`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-Notification-OrderStatusChange.html) | Order owner | | ||
| | [`Ibexa\Contracts\Payment\Notification\PaymentStatusChange`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Payment-Notification-PaymentStatusChange.html) | Order owner | | ||
| | [`Ibexa\Contracts\Shipping\Notification\ShipmentStatusChange`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Shipping-Notification-ShipmentStatusChange.html) | Order owner | | ||
| | [`Ibexa\Contracts\User\Notification\UserInvitation`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-User-Notification-UserInvitation.html) | TODO: Given email address | | ||
| | [`Ibexa\Contracts\User\Notification\UserPasswordReset`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-User-Notification-UserPasswordReset.html) | TODO: Given email address | | ||
| | [`Ibexa\Contracts\User\Notification\UserRegister`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-User-Notification-UserRegister.html) | TODO | | ||
| | `Ibexa\Share\Notification\ContentEditInvitationNotification`<br>(alias `ibexa_content_edit_invitation`) | TODO: Given users | | ||
| | `Ibexa\Share\Notification\ContentViewInvitationNotification`<br>(alias `ibexa_content_view_invitation`) | TODO: Given users | | ||
| | `Ibexa\Share\Notification\ExternalParticipantContentViewInvitationNotification`<br>(alias `ibexa_external_participant_content_view_invitation`) | TODO: Given email addresses | | ||
|
|
||
| Notice that `Ibexa\AdminUi\Notifier\Notification\UserInvitation` are sent by the back office and don't implement `Ibexa\Contracts\User\Notification\UserInvitation` which is made for front end users and other more generic usages. | ||
|
Check notice on line 55 in docs/api/notification_channels.md
|
||
| Same for the two `UserPasswordReset` in distinct namespaces. | ||
|
|
||
| ### Available notification channels | ||
|
|
||
|
|
@@ -79,6 +89,49 @@ | |
| php bin/console ibexa:debug:config notifications.subscriptions --siteaccess=<siteaccess> | ||
| ``` | ||
|
|
||
| For example, the following command returns the subscription for the `admin` siteaccess. | ||
| You should see subscriptions to handle back office password reset and user invitation, and the share invitations through, at least, `email`. | ||
|
|
||
| ```bash | ||
| php bin/console ibexa:debug:config notifications.subscriptions --siteaccess=admin --json | jq | ||
| ``` | ||
| ```json | ||
| { | ||
| "ibexa_content_edit_invitation": { | ||
| "channels": [ | ||
| "ibexa", | ||
| "email" | ||
| ] | ||
| }, | ||
| "ibexa_content_view_invitation": { | ||
| "channels": [ | ||
| "ibexa", | ||
| "email" | ||
| ] | ||
| }, | ||
| "ibexa_external_participant_content_view_invitation": { | ||
| "channels": [ | ||
| "email" | ||
| ] | ||
| }, | ||
| "Ibexa\\AdminUi\\Notifier\\Notification\\UserPasswordReset": { | ||
| "channels": [ | ||
| "email" | ||
| ] | ||
| }, | ||
| "Ibexa\\AdminUi\\Notifier\\Notification\\UserInvitation": { | ||
| "channels": [ | ||
| "email" | ||
| ] | ||
| }, | ||
| "Ibexa\\Contracts\\FormBuilder\\Notifications\\FormSubmitted": { | ||
| "channels": [ | ||
| "email" | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| #### Subscription example | ||
|
|
||
| The following example shows how you can deliver notifications about Commerce-related activities through Slack: | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could expose the default result.
--json | jqis optional, it rturn unformmated but readable JSON by default. I don't know what to do withFormSubmittedfrom ibexa/recipes-dev#257It seems not immediately needed but it could be needed in the rare case someone use the form builder for an admin form.