Call Index
This API Reference describes the elements and attributes for each call in the Client Alerts API.
Retrieves a list of public channel messages.
Note: All methods of the Client Alerts API will be decommisioned on May 31, 2023. The alternative for this API is Platform Notifications, which supports all notification event types supported by Client Alerts API.
For anyone that is not familiar with Platform Notifications, we recommend that you read the Platform Notifications Guide to get started.
Login is required if you are using the GetUserAlerts call, which retrieves alerts about items associated with a user who has subscribed to the alerts using the Trading API call SetNotificationPreferences. GetPublicAlerts does not require authentication, because it returns alerts about public events on the eBay web site.
Additional resources are available for this API. Please see the eBay Developer Documentation Center.
See also the calls in the eBay Trading API.
Call | Summary | Samples |
---|---|---|
GetPublicAlerts | Retrieves a list of public channel messages. Input should be in name-value pair format. | n/a |
GetUserAlerts | Retrieves alerts privately subscribed to by the user. Input should be in name-value pair format. | n/a |
Login | Logs the client application in to the client alerts server. All subsequent GetUserAlerts calls will require the SessionID returned by this call. The SessionData element returned by this call includes a timestamp to keep track of when alerts have been retrieved. Request should be in name- value pair format. Return will be in JSON. | n/a |
Logout | Logs the client application out of the client alerts server. Input should be in name-value pair format. Output will be in JSON. | n/a |