Sign in
Webhook

Webhook configuration

Configure webhook settings. Go to Setting -> Advance -> Third-party connection -> Webhook/API to configure:

  • Webhook URL (Required)
  • Email error message
  • Request Headers
  • Webhook types: orders, customers, products, variations_warehouses, or auto_call

Webhook Response Types

When webhook is enabled, the system sends POST requests to the configured URL. Response schema:

  • orders: See WebhookOrderResponse schema
  • customers: See WebhookCustomerResponse schema
  • products: See WebhookProductResponse schema
  • variations_warehouses: See WebhookInventoryResponse schema
  • auto_call: See WebhookAutoCallResponse schema
put/shops/{SHOP_ID}

Path parameters

SHOP_IDinteger required
Example:4

Shop ID

Request body

Example request

{
  "shop": {
    "webhook_enable": true,
    "webhook_url": "https://test.com",
    "webhook_email": "1234@gmail.com",
    "webhook_types": [
      "orders",
      "customers",
      "variations_warehouses"
    ],
    "webhook_partner": "",
    "webhook_headers": {
      "X-API-KEY": "elqsF9ERiFWGacWQO9Gg5XC4kXojot"
    }
  }
}

Response

Success

successboolean

Success status

Changes

No recorded changes to this endpoint across all 1 revision of this API.