Skip to content
/Endpoints

Webhook URL Configuration

Request

This API enables developers to configure webhook URLs for receiving real-time notifications from the Keeta platform regarding orders, stores, menus, and other relevant business events.

Bodyapplication/jsonrequired
eventIdintegerrequired

Represents the message type code for push notifications

Example:1001
urlstringrequired

The webhook URL provided by developers where Keeta system will send notifications

Example:"https://open.mykeeta.com/api/open/base/image/upload"
isTestintegerrequired

Indicates whether this request comes from a test store:

  • 0: Production store (non-test)

  • 1: Test store (default value if not specified)

Example:1
POST
/base/callback/url/set
curl -i -X POST \
  https://open.mykeeta.com/api/open/base/callback/url/set \
  -H 'Content-Type: application/json' \
  -d '{
    "eventId": 1001,
    "url": "https://open.mykeeta.com/api/open/base/image/upload",
    "isTest": 1
  }'

Responses

Webhook URL configuration result.

Bodyapplication/json
codeintegerrequired

A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.

Enum ValueDescription
0

The request was executed successfully.

Non-zero value

The request execution failed. Specific error details can be viewed in the message field.

Example:0
messagestringrequired

Text description corresponding to the status code, explaining the operation result or error cause to users.

Example:"Success"
Response
{
  "code": 0,
  "message": "Success"
}