{ "openapi": "3.0.0", "info": { "title": "Notification API", "description": "The eBay Notification API enables management of the entire end-to-end eBay notification experience by allowing users to:
Important! The retrieved public key value should be cached for a temporary — but reasonable — amount of time (e.g., one-hour is recommended.) This key should not be requested for every notification since doing so can result in exceeding API call limits if a large number of notification requests is received.
$schema
and $id
definitions.PENDING
status until they are reviewed. If a filter is valid, it will move from PENDING
status to ENABLED
status. You can find the status of a filter using the getSubscriptionFilter method. See Creating a subscription filter for a topic for additional information.true
in the response.ENABLED
or DISABLED
. For implementation help, refer to eBay API documentation"
},
"payload": {
"description": "The payload associated with the notification topic. Use getTopics or getTopic to get the supported payload for the topic.",
"$ref": "#/components/schemas/SubscriptionPayloadDetail"
},
"destinationId": {
"type": "string",
"description": "The unique identifier of the destination endpoint that will receive notifications associated with this subscription. Use the getDestinations method to retrieve destination IDs."
}
},
"description": "This type contains information about a subscription request."
},
"DeliveryConfig": {
"type": "object",
"properties": {
"endpoint": {
"type": "string",
"description": "The endpoint for this destination."
},
"verificationToken": {
"type": "string",
"description": "The verification token associated with this endpoint."
}
},
"description": "A type that contains information about the delivery configuration."
},
"Destination": {
"type": "object",
"properties": {
"destinationId": {
"type": "string",
"description": "The unique identifier for the destination."
},
"name": {
"type": "string",
"description": "The name associated with this destination."
},
"status": {
"type": "string",
"description": "The status for this destination.ENABLED
DISABLED
MARKED_DOWN
ENABLED
or DISABLED
.JSON
is the only supported format.",
"items": {
"type": "string",
"description": " For implementation help, refer to eBay API documentation"
}
},
"deliveryProtocol": {
"type": "string",
"description": "The supported delivery protocols. For implementation help, refer to eBay API documentation"
},
"deprecated": {
"type": "boolean",
"description": "A deprecation indicator."
}
},
"description": "A type that describes the details about a topic's payload."
},
"PublicKey": {
"type": "object",
"properties": {
"algorithm": {
"type": "string",
"description": "The algorithm associated with the public key that is returned, such as Elliptic Curve Digital Signature Algorithm (ECDSA)."
},
"digest": {
"type": "string",
"description": "The digest associated with the public key that is returned, such as Secure Hash Algorithm 1 (SHA1)."
},
"key": {
"type": "string",
"description": "The public key that is returned for the specified key ID.HTTPS
is currently the only supported delivery protocol of all notification topics. For implementation help, refer to eBay API documentation"
}
},
"description": "A type that describes the details of the subscription payload."
},
"SubscriptionSearchResponse": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of matches for the search criteria.",
"format": "int32"
},
"href": {
"type": "string",
"description": "The path to the call URI that produced the current page of results."
},
"next": {
"type": "string",
"description": "The URL to access the next set of results. This field includes a continuation_token. No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page.20
if omitted.20
if omitted.",
"format": "int32"
},
"topics": {
"type": "array",
"description": "An array of topics that match the specified criteria.",
"items": {
"$ref": "#/components/schemas/Topic"
}
}
},
"description": "A type that describes the details of the topic search response."
},
"UpdateSubscriptionRequest": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Set the status of the subscription being updated to ENABLED or DISABLED. For implementation help, refer to eBay API documentation"
},
"payload": {
"description": "The payload associated with this subscription.",
"$ref": "#/components/schemas/SubscriptionPayloadDetail"
},
"destinationId": {
"type": "string",
"description": "The unique identifier of the destination endpoint that will receive notifications associated with this subscription. Use getDestinations to retrieve destination IDs."
}
},
"description": "A type that describes the details of the update subscription request."
}
},
"securitySchemes": {
"api_auth": {
"type": "oauth2",
"description": "The security definitions for this API. Please check individual operations for applicable scopes.",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope": "View public data from eBay"
}
},
"authorizationCode": {
"authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
"tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
"scopes": {
"https://api.ebay.com/oauth/api_scope/commerce.notification.subscription.readonly": "View your event notification subscriptions",
"https://api.ebay.com/oauth/api_scope/commerce.notification.subscription": "View and manage your event notification subscriptions"
}
}
}
}
}
}
}