Skip to content

Commit fcef987

Browse files
committed
CEXT-4524: Add ACCS event subscription docs
1 parent 76cd963 commit fcef987

File tree

5 files changed

+63
-0
lines changed

5 files changed

+63
-0
lines changed

src/data/navigation/sections/events.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ module.exports = [
2727
title: "Create conditional events",
2828
path: "/events/conditional-events.md",
2929
},
30+
{
31+
title: "Events Subscriptions grid for Adobe Commerce as a Cloud Service",
32+
path: "/events/events-subscriptions-grid.md",
33+
},
3034
{
3135
title: "Add custom fields",
3236
path: "/events/custom-event-fields.md"
Loading
Loading
Loading
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Events Subscriptions grid for Adobe Commerce as a Cloud Service
3+
description: Learn about managing events subscriptions through the admin in Commerce Cloud Service.
4+
keywords:
5+
- ACCS
6+
- Events
7+
- Extensibility
8+
---
9+
10+
# Managing Events through the Admin in Adobe Commerce as a Cloud Service
11+
12+
In addition to the available [REST endpoints for event subscriptions](./api.md), Adobe Commerce as a Cloud Service also supports managing events through the Admin.
13+
14+
## View event subscriptions
15+
16+
In the Admin, select **System** > **Events** > **Events Subscriptions** to display the _Events Subscriptions_ grid page.
17+
18+
![Events Subscriptions grid page](../_images/events/events-subscriptions-grid.png)
19+
20+
The rows of this grid show configuration settings for all event subscriptions, both enabled and disabled.
21+
22+
## Create a new event subscription
23+
24+
Click **Add New Subscription** from the grid page to display the form for creating a new event subscription.
25+
26+
![New event subscription](../_images/events/event-subscription-settings.png)
27+
28+
The **Event subscription settings** configuration panel contains the following fields:
29+
30+
Field | Description
31+
--- | ---
32+
**Event Name** | Select one of the supported Commerce event names from the dropdown.
33+
**Event Name Alias** | A unique alias name for the event. An alias is required for events that have rules configured.
34+
**Event Provider** | Select the event provider to which the event should be delivered. If a workspace configuration is set for the provider, event metadata will be created and linked to the provider when the event subscription is saved.
35+
**Is Enabled** | Indicates whether the event is enabled. Disabled events are not emitted from Commerce.
36+
**Priority** | Indicates whether the event has priority status. Priority events are sent within a second, whereas non-priority events can take up to 59 seconds to send.
37+
38+
### Configure event subscription fields
39+
40+
The **Event Subscription Fields** configuration panel allows you to define the fields of the event payload to transmit from Commerce. The name provides the path to the field in the event payload. See [Register events](./module-development.md#register-events) for details on specifying event field names.
41+
42+
### Configure event subscription rules
43+
44+
The **Event Subscription Rules** configuration panel allows you to define rules that determine when an event with a name alias is triggered. [Create conditional events](./conditional-events.md) describes how to configure rules.
45+
46+
Field | Description
47+
--- | ---
48+
**Field** | The name of the event field to be evaluated.
49+
**Value** | The value to be compared.
50+
**Operator** | Defines which comparison operator to use. Examples include `lessThan`, `regex`, and `equal`.
51+
52+
## Events Subscriptions grid actions
53+
54+
Click **Select** > **Edit** in the **Action** column of an event subscription's row to display a form for editing the subscription.
55+
56+
# TODO: replace image
57+
![Edit event subscription](../_images/events/edit-event-subscription.png)
58+
59+
Click **Select** > **Delete** in the **Action** column to delete an event subscription.

0 commit comments

Comments
 (0)