Skip to content

Commit 6f03ce5

Browse files
committed
CEXT-3923: Documented the get event provider endpoint
1 parent 775b1a8 commit 6f03ce5

File tree

3 files changed

+43
-1
lines changed

3 files changed

+43
-1
lines changed

src/pages/events/api.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,3 +140,35 @@ curl -i -X PUT \
140140
}' \
141141
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/updateConfiguration'
142142
```
143+
144+
## Get configured event provider information
145+
146+
The `GET /rest/<store_view_code>/V1/eventing/getEventProviders` endpoint returns information about the event provider configured for the Commerce instance.
147+
148+
**Headers:**
149+
150+
`Authorization: Bearer <administrator token>`
151+
152+
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_list` resource.
153+
154+
**Example usage:**
155+
156+
The following cURL command retrieves information about the configured event provider:
157+
158+
```bash
159+
curl -H "Authorization:Bearer <AUTH_TOKEN>" \
160+
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/getEventProviders' \
161+
```
162+
163+
**Example response:**
164+
165+
```json
166+
[
167+
{
168+
"provider_id": "ad667bc6-1678-49ff-99fc-215d71ebf82f",
169+
"instance_id": "my_instance",
170+
"label": "my_provider",
171+
"description": "Provides out-of-process extensibility for Adobe Commerce"
172+
}
173+
]
174+
```

src/pages/events/release-notes.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ These release notes describe the latest version of Adobe I/O Events for Adobe Co
1212

1313
See [Update Adobe I/O Events for Adobe Commerce](installation.md#update-adobe-io-events-for-adobe-commerce) for upgrade instructions.
1414

15+
## Version 1.10.0
16+
17+
### Release date
18+
19+
December 10, 2024
20+
21+
### Enhancements
22+
23+
* Added the `GET /rest/<store_view_code>/V1/eventing/getEventProviders` REST endpoint for retrieving information about the configured event provider. <!---CEXT-3913 -->
24+
1525
## Version 1.9.0
1626

1727
### Release date

src/pages/webhooks/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The resolution of a remote call also determines whether you should implement a w
2727

2828
Use these guidelines to develop your own webhooks:
2929

30-
1. Identify the Adobe Commerce event that triggers a webhook. Adobe Commerce merchants can browse the available events from the Admin by selecting **System** > Events > **Events** to display the Events list page.
30+
1. Identify the Adobe Commerce event that triggers a webhook. Adobe Commerce merchants can browse the available events from the Admin by selecting **System** > Events > **Events List** to display the Events list page.
3131

3232
1. Understand the default payload of the corresponding webhook by running the [`bin/magento webhooks:info` command](commands.md#display-the-payload-of-a-webhook).
3333

0 commit comments

Comments
 (0)