Skip to main content

【EC-CUBE】Configuring Webhooks

Updated

Configuring webhooks lets KOMOJU notify EC-CUBE of payment events, so your order statuses update automatically.

Without webhooks, your order statuses will not update automatically. Setup requires both copying the URL/secret on the EC-CUBE side and registering them in the KOMOJU Dashboard.
Also, webhooks must be registered separately for Live Mode and Test Mode. Registering one does not carry over to the other.

What Webhooks Do

Webhooks allow KOMOJU to notify your EC-CUBE store when payment events occur (captures, refunds, cancellations, etc.). Without webhooks, your order statuses will not update automatically.

Copy the Webhook URL and Secret (EC-CUBE Side)

  1. In your EC-CUBE admin panel, navigate to KOMOJU Payment → Settings
  2. Open the Webhook Configuration card
  3. Note the Webhook Secret (click the copy button to copy this value) and the Webhook Endpoint URL (the URL that KOMOJU will send events to), and copy each of them

Register the Webhook in the KOMOJU Dashboard

  1. Go to the KOMOJU Dashboard
  2. Navigate to Manage → Webhook
  3. Add a new webhook using the endpoint URL and secret copied from EC-CUBE
  4. Enable the following events:
    • payment.captured
    • payment.refunded
    • payment.cancelled
    • payment.expired
    • payment.failed
    • payment.updated
    • payment.authorized

All Events Must Be Enabled

All 7 events listed above are required for the plugin to function correctly. Missing events may cause order statuses to fall out of sync. Double-check that every event is checked when you register the webhook.

Why Live Mode and Test Mode Each Need Their Own Registration

A webhook registered in Test Mode on the KOMOJU Dashboard does not carry over to Live Mode. Likewise, a webhook registered in Live Mode does not carry over to Test Mode.

For this reason, switch to the appropriate mode and register a webhook separately for testing and for production use. Before going live, switch the KOMOJU Dashboard to Live Mode, repeat the registration steps above, and confirm that a webhook is registered for Live Mode.

How to Switch Between Live Mode and Test Mode

You switch modes using the toggle switch in the bottom left of the KOMOJU Dashboard.

If You Don't See the Toggle Switch

This toggle switch is only displayed once Live Mode is active. If your Live Mode application has not yet been approved, the toggle switch itself will not appear. In that case, complete your Live Mode application first.

Using Live Mode Requires an Application

Live Mode (commercial use) requires an application and approval. You can apply from the "Start accepting payments" button in the top right of the KOMOJU Dashboard (this requires a review and contract process). Test Mode is available immediately upon signup and does not require an application. See "How to Try Out KOMOJU's Features" for details.

Related Articles