Manage webhook endpoint

Webhook Register info

Register for data entry

API Endpoint

URL {base url}/api/WebHook/HookRegisterInfo
Method POST
Authorization Bearer Token
Content-Type application/json

Request Headers

Parameter Type Required Description
APIKEY string true System key code

Request Parameters

Parameter Type Required Description
Action string true Information to be received
  • ORDER_STATUS
  • INBOUND_SHIP
EndpointUrl string true Receiving address
DefaultToken string false Default endpoint Token
AuthType string false Authorization Type
Email string true e-mail for contact
Active bool true Ready to use

Request JSON Example


{
  "Action": "ORDER_STATUS",
  "EndpointUrl": "https://webhook.site/480db11c-5d0e-4b12-8b38-1ef8d229",
  "Email": "info@gmail.com",
  "Active": true
}

Response Parameters

Parameter Type Description
Id integer Error status (0 = no error)
Success boolean Request status
Message string Reply message
RequestId string Reference code for request
Size integer Number of successful completions
Data object Normally it is null.

Response JSON Example


{
    "Id": 0,
    "Success": true,
    "Message": "https://webhook.site/480db11c-5d0e-4b12-8b38-1ef8d229 is registerd",
    "RequestId": "68C7A25A-F5B5-40E6-8F7A-CBED7365D901",
    "Size": 1,
    "Data": null
}