Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

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


Method NameHTTP MethodPathSummarySamples
getConfigGET/configRetrieves the alert email address associated with the user.View getConfig - /config
updateConfigPUT/configUpdates the alert email address associated with the user.View updateConfig - /config


Method NameHTTP MethodPathSummarySamples
createDestinationPOST/destinationDesignates an endpoint that will receive notifications.View createDestination - /destination
deleteDestinationDELETE/destination/{destination_id}Deletes a disabled destination endpoint.View deleteDestination - /destination/{destination_id}
getDestinationGET/destination/{destination_id}Retrieves the details of a destination endpoint.View getDestination - /destination/{destination_id}
getDestinationsGET/destinationRetrieves the details of all destination endpoints set up by a user.View getDestinations - /destination
updateDestinationPUT/destination/{destination_id}Changes the status and/or name of a destination endpoint.View updateDestination - /destination/{destination_id}


Method NameHTTP MethodPathSummarySamples
getPublicKeyGET/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}


Method NameHTTP MethodPathSummarySamples
createSubscriptionPOST/subscriptionSubscribes a user to a notification topic.View createSubscription - /subscription
createSubscriptionFilterPOST/subscription/{subscription_id}/filterCreates 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
deleteSubscriptionDELETE/subscription/{subscription_id}Deletes a notification topic subscription.View deleteSubscription - /subscription/{subscription_id}
deleteSubscriptionFilterDELETE/subscription/{subscription_id}/filter/{filter_id}Deletes a notification topic subscription filter.View deleteSubscriptionFilter - /subscription/{subscription_id}/filter/{filter_id}
disableSubscriptionPOST/subscription/{subscription_id}/disableDisables a previously enabled notification topic subscription.View disableSubscription - /subscription/{subscription_id}/disable
enableSubscriptionPOST/subscription/{subscription_id}/enableEnables a previously disabled notification topic subscription.View enableSubscription - /subscription/{subscription_id}/enable
getSubscriptionGET/subscription/{subscription_id}Retrieves details on a notification topic subscription.View getSubscription - /subscription/{subscription_id}
getSubscriptionFilterGET/subscription/{subscription_id}/filter/{filter_id}Retrieves details of a notification topic subscription filterView getSubscriptionFilter - /subscription/{subscription_id}/filter/{filter_id}
getSubscriptionsGET/subscriptionRetrieves details on all of a user's notification topic subscriptions.View getSubscriptions - /subscription
testSubscriptionPOST/subscription/{subscription_id}/testSends a test notification to a user's destination endpoint for a notification topic subscription.View testSubscription - /subscription/{subscription_id}/test
updateSubscriptionPUT/subscription/{subscription_id}Makes one or more changes to a notification topic subscription.View updateSubscription - /subscription/{subscription_id}


Method NameHTTP MethodPathSummarySamples
getTopicGET/topic/{topic_id}Retrieves details of a notification topic.View getTopic - /topic/{topic_id}
getTopicsGET/topicRetrieves details of all available notification topics.View getTopics - /topic