guideWebhooks testing

A crucial part of any integration is testing. To this end, CKEditor Cloud Services provides several tools that facilitate the testing of integration with webhooks.

# Ping event

After creating a webhook, CKEditor Cloud Services sends a straightforward ping event that can be used to confirm that the integration works correctly.

Payload:

  • id – The ID of the request.
  • url – The URL of the request.

# Example

You can find an example of a ping event sent by CKEditor Cloud Services below.

{
    "event": "ping",
    "environment_id": "environment-1",
    "payload": {
        "id": "id",
        "url": "url",
    },
    "sent_at": "2019-05-29T08:17:53.457Z"
}

# CKEditor Ecosystem customer dashboard

In CKEditor Ecosystem customer dashboard, for each environment there is a list of existing webhooks together with a list of sent requests. Each request on the list can be resent and contains some relevant and useful information, such as:

  • request body,
  • request headers,
  • response status,
  • response body,
  • response headers,
  • duration.

Note: The response body and headers are saved for all requests with a status other than 2xx.

The image below shows the recent activity for a selected endpoint.

Requests history list in CKEditor Cloud Services customer dashboard.

Clicking “Details” reveals more information about a particular webhook request.

Webhook request details in CKEditor Cloud Services customer dashboard.