createDestination | eBay Notification API

POST/destination

This method allows applications to create a destination. A destination is an endpoint that receives HTTP push notifications.

A single destination for all topics is valid, as is individual destinations for each topic.

To update a destination, use the updateDestination call.

The destination created will need to be referenced while creating or updating a subscription to a topic.

Note: The destination should be created and ready to respond with the expected challengeResponse for the endpoint to be registered successfully. Refer to the Notification API overview for more information.

Input

Resource URI

POST https://api.ebay.com/commerce/notification/v1/destination

This method is not supported in Sandbox environment.

URI parameters

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

In addition, this method requires you to include the Content-Type header and its value should be set to "application/json". See HTTP request headers- opens rest request components page for details.

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

{ /* DestinationRequest */

"name" : "string",

"status" : "DestinationStatusEnum : [ENABLED,DISABLED,MARKED_DOWN]",

"deliveryConfig" :

{ /* DeliveryConfig */

"endpoint" : "string",

"verificationToken" : "string"

}

Request fields

Input container/field	Type	Description
name	string	The name associated with this destination. Occurrence: Optional
status	DestinationStatusEnum	The status for this destination. Note: The MARKED_DOWN value is set by eBay systems and cannot be used in a create or update call by applications. Valid values: `ENABLED` `DISABLED` `MARKED_DOWN` Occurrence: Required
deliveryConfig	DeliveryConfig	The configuration associated with this destination. Occurrence: Required
deliveryConfig.endpoint	string	The endpoint for this destination. Occurrence: Required
deliveryConfig.verificationToken	string	The verification token associated with this endpoint. Occurrence: Required

Output

HTTP response headers

See HTTP response headers for details.

Header	Meaning
Location	The destination resource created.

Response payload

This call has no payload.

Response fields

This call has no field definitions.

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
201	Created
400	Bad Request
409	Conflict
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
195000	API_NOTIFICATION	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
195003	API_NOTIFICATION	REQUEST	Please provide configurations required for notifications. Refer to /config
195016	API_NOTIFICATION	REQUEST	Invalid name. Markups or lengths greater than 64 not supported
195017	API_NOTIFICATION	REQUEST	Invalid or missing endpoint.
195018	API_NOTIFICATION	REQUEST	Invalid or missing destination status. Supported values:[ENABLED,DISABLED]
195019	API_NOTIFICATION	REQUEST	Invalid or missing verification token for this endpoint.
195020	API_NOTIFICATION	REQUEST	Challenge verification failed for requested endpoint
195021	API_NOTIFICATION	REQUEST	Destination exists for this endpoint

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Create a destination

This call creates a destination.

Input

The inputs are the optional name, and the required deliveryConfig including the endpoint and the verificationToken.

POSThttps://api.ebay.com/commerce/notification/v1/destination

Output

A successful call returns the HTTP status code 204 No Content. This method has no response payload.