guideWebhooks management

Webhooks management is available for every environment in the CKEditor Ecosystem customer dashboard for SaaS or in the Management Panel for On-Premises. Select the environment from the list of environments and navigate to the “Webhooks” tab to review existing webhooks and add new ones.

Environments list with webhooks management in CKEditor Ecosystem customer dashboard.

The webhooks management page shows existing webhooks and a button to add new ones. The list is empty until you define some webhooks for a particular environment.

New webhook button in CKEditor Ecosystem customer dashboard.

When creating a new webhook, you should select which events should be sent. You also need to provide an endpoint URL that CKEditor Cloud Services will send the requests to. Additionally you can enable and configure the failed request retries option, although it is not mandatory. In case of an unsuccessful request delivery, the retry mechanism will resend the failed requests after a declared time. The retries are continued until a successful delivery or until a declared retries limit is reached. The request delivery is treated as failed if the request destination response contains the status code different than 2XX.

Defining new webhooks in CKEditor Ecosystem customer dashboard.

An added webhook will appear on the list.

Webhooks list in CKEditor Ecosystem customer dashboard.

Each webhook visible in this list can be edited (you can change its URL, retries settings and events) as well as removed. It can be done by clicking the “Edit” button.

Editing webhook in CKEditor Ecosystem customer dashboard.

If you decide to disable the previously enabled retries mechanism for a particular webhook, it will cancel all pending retries for that webhook. Additionally, for each webhook you can review the history of the request. This can be used during the testing, integration or debugging.

You can read more about the request history in the Webhooks testing guide.