Webhook Create

Webhook Create

With this service, you can set up a webhook structure for your order packages.

• The ID value returned as a service response is the ID value of the webhook structure you have installed, and must be used in update and delete operations.

• Requests to be sent to integration services must be authorized with the basic authentication method as "basic authentication".

  • SellerId, API KEY and API SECRET KEY information used for Basic Authentication must be obtained from the "Integration Information" page in the "My Account Information" section of the seller panel.

• If your service expects api key in the header, it will be sent as "x-api-key".

POST createWebhook

Input Parameters

The statuses you can enter for the "subscribedStatuses" field are as follows:

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"

Sample Service Request

{
    "url": "https://testwebhook.com",
    "username": "user",
    "password": "password",
    "authenticationType": "API_KEY",
    "apiKey": "123456",
    "subscribedStatuses": ["CREATED", "PICKING"]
 }

Sample Service Response

{
  "id": "string"
}