Notification API resources | eBay Developers Program

Skip to main content

Important Update: eBay's API integrations will be modified to address data handling requirements for select developers. Usernames will be replaced with immutable user IDs, and financial data will be protected for certain users. Learn more here.
API License Agreement Update: We have made significant enhancements to our API License Agreement, including detailed data protection measures and compliance with international regulations. Important restrictions have been applied to the use of Restricted APIs and AI content. Developers must review the updated agreement to ensure compliance.

The eBay Notification API enables management of the entire end-to-end eBay notification experience by allowing users to:

Browse for supported notification topics and retrieve topic details
Create, configure, and manage notification destination endpoints
Configure, manage, and test notification subscriptions
Process eBay notifications and verify the integrity of the message payload

config

Method Name	HTTP Method	Path	Summary	Samples
getConfig	GET	/config	Retrieves the alert email address associated with the user.	View getConfig - /config
updateConfig	PUT	/config	Updates the alert email address associated with the user.	View updateConfig - /config

destination

Method Name	HTTP Method	Path	Summary	Samples
createDestination	POST	/destination	Designates an endpoint that will receive notifications.	View createDestination - /destination
deleteDestination	DELETE	/destination/{destination_id}	Deletes a disabled destination endpoint.	View deleteDestination - /destination/{destination_id}
getDestination	GET	/destination/{destination_id}	Retrieves the details of a destination endpoint.	View getDestination - /destination/{destination_id}
getDestinations	GET	/destination	Retrieves the details of all destination endpoints set up by a user.	View getDestinations - /destination
updateDestination	PUT	/destination/{destination_id}	Changes the status and/or name of a destination endpoint.	View updateDestination - /destination/{destination_id}

public_key

Method Name	HTTP Method	Path	Summary	Samples
getPublicKey	GET	/public_key/{public_key_id}	Retrieves a key that is needed to validate an eBay push notification message payload.	View getPublicKey - /public_key/{public_key_id}

subscription

Method Name	HTTP Method	Path	Summary	Samples
createSubscription	POST	/subscription	Subscribes a user to a notification topic.	View createSubscription - /subscription
createSubscriptionFilter	POST	/subscription/{subscription_id}/filter	Creates a filter for a notification topic subscription that will control whether or not a notification is sent to a user's destination endpoint.	View createSubscriptionFilter - /subscription/{subscription_id}/filter
deleteSubscription	DELETE	/subscription/{subscription_id}	Deletes a notification topic subscription.	View deleteSubscription - /subscription/{subscription_id}
deleteSubscriptionFilter	DELETE	/subscription/{subscription_id}/filter/{filter_id}	Deletes a notification topic subscription filter.	View deleteSubscriptionFilter - /subscription/{subscription_id}/filter/{filter_id}
disableSubscription	POST	/subscription/{subscription_id}/disable	Disables a previously enabled notification topic subscription.	View disableSubscription - /subscription/{subscription_id}/disable
enableSubscription	POST	/subscription/{subscription_id}/enable	Enables a previously disabled notification topic subscription.	View enableSubscription - /subscription/{subscription_id}/enable
getSubscription	GET	/subscription/{subscription_id}	Retrieves details on a notification topic subscription.	View getSubscription - /subscription/{subscription_id}
getSubscriptionFilter	GET	/subscription/{subscription_id}/filter/{filter_id}	Retrieves details of a notification topic subscription filter	View getSubscriptionFilter - /subscription/{subscription_id}/filter/{filter_id}
getSubscriptions	GET	/subscription	Retrieves details on all of a user's notification topic subscriptions.	View getSubscriptions - /subscription
testSubscription	POST	/subscription/{subscription_id}/test	Sends a test notification to a user's destination endpoint for a notification topic subscription.	View testSubscription - /subscription/{subscription_id}/test
updateSubscription	PUT	/subscription/{subscription_id}	Makes one or more changes to a notification topic subscription.	View updateSubscription - /subscription/{subscription_id}

topic

Method Name	HTTP Method	Path	Summary	Samples
getTopic	GET	/topic/{topic_id}	Retrieves details of a notification topic.	View getTopic - /topic/{topic_id}
getTopics	GET	/topic	Retrieves details of all available notification topics.	View getTopics - /topic