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 Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getPublicKey | GET | /public_key/{public_key_id} | Retrieves the public key for a specified public key ID. | View getPublicKey - /public_key/{public_key_id} |
topic
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getTopic | GET | /topic/{topic_id} | Retrieves details for the specified topic ID. | View getTopic - /topic/{topic_id} |
| getTopics | GET | /topic | Retrieves the details and statuses of supported topics. | View getTopics - /topic |
subscription
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createSubscription | POST | /subscription | Creates a subscription to a topic. | View createSubscription - /subscription |
| updateSubscription | PUT | /subscription/{subscription_id} | Updates a subscription for a topic. | View updateSubscription - /subscription/{subscription_id} |
| enableSubscription | POST | /subscription/{subscription_id}/enable | Enables a subscription for a topic. | View enableSubscription - /subscription/{subscription_id}/enable |
| disableSubscription | POST | /subscription/{subscription_id}/disable | Disables a subscription for a topic. | View disableSubscription - /subscription/{subscription_id}/disable |
| getSubscription | GET | /subscription/{subscription_id} | Retrieves subscription details for the specified subscription. | View getSubscription - /subscription/{subscription_id} |
| getSubscriptions | GET | /subscription | Retrieves a paginated collection of subscription resources. | View getSubscriptions - /subscription |
| deleteSubscription | DELETE | /subscription/{subscription_id} | Deletes a subscription. | View deleteSubscription - /subscription/{subscription_id} |
| testSubscription | POST | /subscription/{subscription_id}/test | Triggers a mocked-test payload to the subscription destination. Use to test your subscription end-to-end. | View testSubscription - /subscription/{subscription_id}/test |
| createSubscriptionFilter | POST | /subscription/{subscription_id}/filter | Creates a subscription filter. | View createSubscriptionFilter - /subscription/{subscription_id}/filter |
| getSubscriptionFilter | GET | /subscription/{subscription_id}/filter/{filter_id} | Retrieves the filter details for the sepcified subscription filter. | View getSubscriptionFilter - /subscription/{subscription_id}/filter/{filter_id} |
| deleteSubscriptionFilter | DELETE | /subscription/{subscription_id}/filter/{filter_id} | Deletes a subscription filter. | View deleteSubscriptionFilter - /subscription/{subscription_id}/filter/{filter_id} |
destination
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| createDestination | POST | /destination | Creates a destination. | View createDestination - /destination |
| updateDestination | PUT | /destination/{destination_id} | Updates a destination. | View updateDestination - /destination/{destination_id} |
| getDestination | GET | /destination/{destination_id} | Retrieves the details for a destination configuration, including the endpoint and verification token. | View getDestination - /destination/{destination_id} |
| getDestinations | GET | /destination | Retrieves a paginated collection of destination resources. | View getDestinations - /destination |
| deleteDestination | DELETE | /destination/{destination_id} | Deletes a destination. | View deleteDestination - /destination/{destination_id} |
config
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| updateConfig | PUT | /config | Creates a new configuration or updates an existing configuration. | View updateConfig - /config |
| getConfig | GET | /config | Retrieves a previously created configuration. | View getConfig - /config |