You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The `GET /rest/<store_view_code>/V1/eventing/getEventProviders` endpoint returns information about the event provider configured for the Commerce instance.
279
+
The event provider management endpoints allow you to create, update, and delete event providers. The event provider must be created in the Adobe Developer Console before registering it in Adobe Commerce.
280
+
281
+
### Create an event provider
282
+
283
+
The `POST /rest/<store_view_code>/V1/eventing/eventProvider` endpoint registers a new event provider in an Adobe Commerce instance. The event provider must be created in the Adobe Developer Console before it can be registered in Adobe Commerce.
284
+
285
+
**Headers:**
286
+
287
+
`Authorization: Bearer <administrator token>`
288
+
289
+
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_edit` resource.
290
+
291
+
**Payload Parameters:**
292
+
293
+
Name | Format | Required | Description
294
+
--- |--------| --- | ---
295
+
`provider_id` | string | required | The event provider ID.
296
+
`instance_id` | string | required | The instance ID of event provider.
297
+
`label` | string | optional | A label of the event provider.
298
+
`description` | string | optional | A description of the event provider.
299
+
`workspace_configuration` | string | optional | The contents of the workspace configuration file downloaded from the Adobe Developer Console associated with the event provider.
300
+
301
+
**Example usage:**
302
+
303
+
The following cURL command registers a new event provider:
The `PUT /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoint updates the event provider with the specified ID. The request body has the same format as the `POST` request except that `id` must be provided.
338
+
339
+
**Headers:**
340
+
341
+
`Authorization: Bearer <administrator token>`
342
+
343
+
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_edit` resource.
344
+
345
+
**Payload Parameters:**
346
+
347
+
Name | Format | Required | Description
348
+
--- |--------| --- | ---
349
+
`id` | integer | required | The ID assigned to the registered event provider.
350
+
`provider_id` | string | required | The event provider ID.
351
+
`instance_id` | string | required | The instance ID of event provider.
352
+
`label` | string | optional | A label of the event provider.
353
+
`description` | string | optional | A description of the event provider.
354
+
`workspace_configuration` | string | optional | The contents of the workspace configuration file downloaded from the Adobe Developer Console associated with the event provider.
355
+
356
+
**Example usage:**
357
+
358
+
The following cURL command updates an event provider:
"description": "Updated description of additional event provider",
386
+
"workspace_configuration": "****"
387
+
}
388
+
```
389
+
390
+
### Delete event provider
391
+
392
+
The `DELETE /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoint deletes the event provider with the specified ID from the Adobe Commerce instance. The event provider is not removed from the Adobe Developer Console.
393
+
394
+
**Headers:**
395
+
396
+
`Authorization: Bearer <administrator token>`
397
+
398
+
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_delete` resource.
399
+
400
+
**Example usage:**
401
+
402
+
The following cURL command deletes an event provider:
The response will return a 200 status code if the event provider was deleted successfully. If the provider ID is not found, an appropriate error is returned.
411
+
412
+
### Get list of all event providers
413
+
414
+
The `GET /rest/<store_view_code>/V1/eventing/eventProvider` endpoint returns a list of all event providers configured for the Commerce instance.
277
415
278
416
**Headers:**
279
417
@@ -283,11 +421,11 @@ The administrator must be granted access to the `Magento_AdobeIoEventsClient::ev
283
421
284
422
**Example usage:**
285
423
286
-
The following cURL command retrieves information about the configured event provider:
424
+
The following cURL command retrieves information about all configured event providers:
The `GET /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoint returns the event provider with the specified ID. If the provider ID is not found, a 404 error is returned.
455
+
456
+
**Headers:**
457
+
458
+
`Authorization: Bearer <administrator token>`
459
+
460
+
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_list` resource.
461
+
462
+
The following cURL command retrieves information about the configured event provider:
Copy file name to clipboardExpand all lines: src/pages/events/commands.md
+20-8Lines changed: 20 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -38,11 +38,11 @@ If you decide to omit the arguments, the `event-types.json` file must have the f
38
38
39
39
```json
40
40
{
41
-
"provider": {
42
-
"label": "My Adobe Commerce Events",
43
-
"description": "Provides out-of-process extensibility for Adobe Commerce"
44
-
}
45
-
}
41
+
"provider": {
42
+
"label": "My Adobe Commerce Events",
43
+
"description": "Provides out-of-process extensibility for Adobe Commerce"
44
+
}
45
+
}
46
46
```
47
47
48
48
As an alternative to above steps, you can click the [Create Event Provider](./configure-commerce.md#commerce-admin) button on the **General configuration** section of the Adobe I/O Events page in the Admin.
@@ -77,12 +77,18 @@ The `events:provider:info` command returns details about a configured event prov
To show registrations only for a specific provider, use the `--provider-id <PROVIDER_ID>` option.
142
+
135
143
## Create event metadata in Adobe I/O
136
144
137
145
The `events:metadata:populate` command creates event metadata based on XML and application configurations. This metadata gets linked to the configured event provider.
@@ -195,7 +203,7 @@ If you are implementing eventing in a performance testing environment, run the `
@@ -217,6 +225,8 @@ If you are implementing eventing in a performance testing environment, run the `
217
225
218
226
`--destination`, `-d` A custom destination for the event. This argument is used for SaaS integrations.
219
227
228
+
`--providerId` The event provider to which events will be delivered. If not provided the default event provider will be used. To configure additional event providers refer to the [Configure additional event providers](./configure-commerce.md) section.
229
+
220
230
`--hipaaAuditRequired` Indicates the event contains data that is subject to HIPAA auditing.`
To return list of subscribed events with verbose output, use the `-v` or `-vv` option.
303
+
292
304
## List supported events
293
305
294
306
The `events:list:all` command returns a list of supported events defined in the specified module. (Commerce Eventing does not support all possible events.) The command returns an error if the specified module has been disabled.
description: Learn how to configure additional event providers in Adobe Commerce.
4
+
keywords:
5
+
- Events
6
+
- Extensibility
7
+
---
8
+
9
+
# Configure additional event providers in Adobe Commerce
10
+
11
+
You might need to connect your Adobe Commerce instance to other event providers besides the [default Commerce event provider](configure-commerce.md#create-an-event-provider) registered in the system configuration.
12
+
13
+
To link your event subscriptions to an additional event provider, the provider must be registered in the Adobe Commerce instance. You can configure the provider from the Adobe Commerce Admin or [through the API](api.md#event-provider-management).
14
+
15
+
## Configure event providers in the Admin
16
+
17
+
To manage event providers in the Adobe Commerce Admin, go to **System** > **Events** > **Event Providers**. The Event Providers page lists all additional event providers configured in your Adobe Commerce instance.
To add a new event provider, click **Add New Provider**. Keep in mind that the event provider must be created in the Adobe I/O Events before you can add it to your Commerce instance. You can create the event provider the using [`aio` CLI tool](https://developer.adobe.com/events/docs/guides/cli/#provider-commands) or to use the [Adobe I/O Events API](https://developer.adobe.com/events/docs/api/#tag/Providers/operation/createProvider).
22
+
23
+
24
+
25
+
`Provider ID` and `Instance ID` are required fields, while the `Workspace Configuration` field is optional. If provided, it synchronizes the event metadata registered with this provider. Otherwise, the creation of event metadata will be skipped. The `Workspace Configuration` must be provided from the workspace where the event provider was created. You can [download the workspace configuration from the Adobe Developer Console](./project-setup.md#download-the-workspace-configuration-file).
26
+
27
+
### Delete an event provider
28
+
29
+
To delete an event provider, select the action next to the provider you want to delete and click **Delete**. A confirmation dialog appears. Click **OK** to confirm the deletion.
30
+
31
+
<InlineAlertvariant="info"slots="text1" />
32
+
33
+
The event provider cannot be deleted if it is used in any event subscriptions. You must first delete the event subscriptions that use this provider.
0 commit comments