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.

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

public_key

Method NameHTTP MethodPathSummarySamples
getPublicKeyGET/public_key/{public_key_id}Retrieves the public key for a specified public key ID.View getPublicKey - /public_key/{public_key_id}

topic

Method NameHTTP MethodPathSummarySamples
getTopicGET/topic/{topic_id}Retrieves details for the specified topic ID.View getTopic - /topic/{topic_id}
getTopicsGET/topicRetrieves the details and statuses of supported topics.View getTopics - /topic

subscription

Method NameHTTP MethodPathSummarySamples
createSubscriptionPOST/subscriptionCreates a subscription to a topic.View createSubscription - /subscription
updateSubscriptionPUT/subscription/{subscription_id}Updates a subscription for a topic.View updateSubscription - /subscription/{subscription_id}
enableSubscriptionPOST/subscription/{subscription_id}/enableEnables a subscription for a topic.View enableSubscription - /subscription/{subscription_id}/enable
disableSubscriptionPOST/subscription/{subscription_id}/disableDisables a subscription for a topic.View disableSubscription - /subscription/{subscription_id}/disable
getSubscriptionGET/subscription/{subscription_id}Retrieves subscription details for the specified subscription.View getSubscription - /subscription/{subscription_id}
getSubscriptionsGET/subscriptionRetrieves a paginated collection of subscription resources.View getSubscriptions - /subscription
deleteSubscriptionDELETE/subscription/{subscription_id}Deletes a subscription.View deleteSubscription - /subscription/{subscription_id}
testSubscriptionPOST/subscription/{subscription_id}/testTriggers a mocked-test payload to the subscription destination. Use to test your subscription end-to-end.View testSubscription - /subscription/{subscription_id}/test
createSubscriptionFilterPOST/subscription/{subscription_id}/filterCreates a subscription filter.View createSubscriptionFilter - /subscription/{subscription_id}/filter
getSubscriptionFilterGET/subscription/{subscription_id}/filter/{filter_id}Retrieves the filter details for the sepcified subscription filter.View getSubscriptionFilter - /subscription/{subscription_id}/filter/{filter_id}
deleteSubscriptionFilterDELETE/subscription/{subscription_id}/filter/{filter_id}Deletes a subscription filter.View deleteSubscriptionFilter - /subscription/{subscription_id}/filter/{filter_id}

destination

Method NameHTTP MethodPathSummarySamples
createDestinationPOST/destinationCreates a destination.View createDestination - /destination
updateDestinationPUT/destination/{destination_id}Updates a destination.View updateDestination - /destination/{destination_id}
getDestinationGET/destination/{destination_id}Retrieves the details for a destination configuration, including the endpoint and verification token.View getDestination - /destination/{destination_id}
getDestinationsGET/destinationRetrieves a paginated collection of destination resources.View getDestinations - /destination
deleteDestinationDELETE/destination/{destination_id}Deletes a destination.View deleteDestination - /destination/{destination_id}

config

Method NameHTTP MethodPathSummarySamples
updateConfigPUT/configCreates a new configuration or updates an existing configuration.View updateConfig - /config
getConfigGET/configRetrieves a previously created configuration.View getConfig - /config