Skip to main content

Pausing/resuming the add-ons

Introduction​

In rare cases, an OAuth Access Token can be paused, which is a condition where the add-on remains installed and billing continues, but API requests are rejected.

This occurs when:

  • the user pauses the add-on in its add-on Manager for various reasons, or
  • the state of the project, where the add-on is installed, was changed (e.g. inactivation of the project).
Did you know?

By using webhooks, you can suspend sending API requests to avoid unnecessary calls that would be rejected anyway.

Webhooks​

When a token (add-on installation) is paused/resumed, the webhook URL is called (if provided) and you can process this webhook notification to (un)suspend sending API requests.

URLs definition​

The URLs for these webhook notifications are available in the Add-on settings, Settings tab, under the Webhook URL to receive ... fields.

For pausing/resuming add-ons, three webhook URL addresses are dedicated:

  • suspend,
  • terminate, and
  • approve.

Suspend or terminate URL is called when the add-on is paused. When the token (add-on installation) is converted back to an approved state, the URL for approve is called to resume the paused add-on.

Notification data​

The information sent will be in regular JSON format:

{
   "eshopId": 125671,
   "event": "addon:suspend",
   "eventCreated": "2025-03-18T15:26:40+0100",
   "eventInstance": 125671
}

The webhook events can acquire:

  • addon:suspend,
  • addon:terminate, and
  • addon:approve values.

The e-shop number is repeated under the eventInstance item.