Skip to main content


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.


Resource URI


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.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Content-TypestringThis header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

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):

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

Request fields

Input container/fieldTypeDescription

This container is used to specify the destination endpoint and verification token associated with this endpoint.

Occurrence: Required


The endpoint for this destination.

Occurrence: Required


The verification token associated with this endpoint.

Occurrence: Required


The seller-specified name for the destination endpoint.

Occurrence: Optional


This field sets the status for the destination endpoint as ENABLED or DISABLED.

Note: The MARKED_DOWN value is set by eBay systems and cannot be used in a create or update call by applications.

Occurrence: Required


HTTP response headers

See HTTP response headers for details.

LocationThe 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.

400Bad Request
500Internal Server Error

Error codes

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

195000API_NOTIFICATIONAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
195003API_NOTIFICATIONREQUESTPlease provide configurations required for notifications. Refer to /config
195016API_NOTIFICATIONREQUESTInvalid name. Markups or lengths greater than 64 not supported
195017API_NOTIFICATIONREQUESTInvalid or missing endpoint.
195018API_NOTIFICATIONREQUESTInvalid or missing destination status. Supported values:[ENABLED,DISABLED]
195019API_NOTIFICATIONREQUESTInvalid or missing verification token for this endpoint.
195020API_NOTIFICATIONREQUESTChallenge verification failed for requested endpoint
195021API_NOTIFICATIONREQUESTDestination exists for this endpoint


This call has no warnings.


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.


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



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