notification APIv1.2.0

API Reference : Resources

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 endpionts
  • 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
/topic
Retrieves the details and statuses of supported topics.View getTopics - /topic

subscription

Method NameHTTP MethodPathSummarySamples
createSubscriptionPOST
/subscription
Creates 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}/enable
Enables a subscription for a topic.View enableSubscription - /subscription/{subscription_id}/enable
disableSubscriptionPOST
/subscription/{subscription_id}/disable
Disables 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
/subscription
Retrieves a paginated collection of subscription resources.View getSubscriptions - /subscription
deleteSubscriptionDELETE
/subscription/{subscription_id}
Deletes a subscription.View deleteSubscription - /subscription/{subscription_id}
testPOST
/subscription/{subscription_id}/test
Triggers a mocked-test payload to the subscription destination. Use to test your subscription end-to-end.View test - /subscription/{subscription_id}/test

destination

Method NameHTTP MethodPathSummarySamples
createDestinationPOST
/destination
Creates 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
/destination
Retrieves 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
/config
Creates a new configuration or updates an existing configuration.View updateConfig - /config
getConfigGET
/config
Retrieves a previously created configuration.View getConfig - /config