HomeGuidesAPI ReferenceChangelogSupport Request
API Reference

Create Webhook - createWebhook

With this service, you can set up a webhook structure for your order packages. If your service expects api key in the header, it will be sent as "x-api-key".

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Seller ID

Body Params
string
required

Webhook Service URL Information

string

Username to be used for Basic Authentication

string

The password to be used for Basic Authentication

string
enum
required

Could be "BASIC_AUTHENTICATION" or "API_KEY"

Allowed:
string

apiKey information which will be used for Authorization

subscribedStatuses
array of strings

Statu list for the order information.

If the "subscribedStatuses" field is sent empty, all the statuses specified below are automatically assigned. If a new status is added to the list below, the added status is defined in the same way for your current webhookID:

  • CREATED
  • PICKING
  • INVOICED
  • SHIPPED
  • CANCELLED
  • DELIVERED
  • UNDELIVERED
  • RETURNED
  • UNSUPPLIED
  • AWAITING
  • UNPACKED
  • AT_COLLECTION_POINT
  • VERIFIED
subscribedStatuses
Headers
string
required

Store front code for region

Responses

400

Bad Request

401

Unauthorized

500

Internal Server Error

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json