Skip to content

Changelog

Learn about new developer features and improvements.

Webhooks API deprecated in favor of new namespaced Core webhooks API

Deprecation notice

The Webhooks API under /api/v1/webhooks is deprecated and will be removed on or after November 1, 2027.

Migrate to the new Core webhooks API under /api/core/webhooks.

The new Core webhooks API in the core namespace replaces the 10 published operations of the Webhooks API.

The following endpoints are deprecated and have a direct replacement:

Deprecated endpointReplacement endpoint
GET /api/v1/webhooksGET /api/core/webhooks
POST /api/v1/webhooksPOST /api/core/webhooks
GET /api/v1/webhooks/{id}GET /api/core/webhooks/{id}
PATCH /api/v1/webhooks/{id}PATCH /api/core/webhooks/{id}
PUT /api/v1/webhooks/{id}PUT /api/core/webhooks/{id}
DELETE /api/v1/webhooks/{id}DELETE /api/core/webhooks/{id}
GET /api/v1/webhooks/{id}/deliveriesGET /api/core/webhooks/{id}/deliveries
GET /api/v1/webhooks/{id}/deliveries/{deliveryId}GET /api/core/webhooks/{id}/deliveries/{deliveryId}
POST /api/v1/webhooks/{id}/deliveries/{deliveryId}/actions/resendPOST /api/core/webhooks/{id}/deliveries/{deliveryId}/actions/resend
GET /api/v1/webhooks/event-typesGET /api/core/webhooks/event-types

The deprecated endpoints continue to work until removal. Plan your migration before the removal date.

To migrate an existing integration:

  1. Replace /api/v1/webhooks with /api/core/webhooks in your API requests.
  2. Keep the remaining path, query parameters, and request bodies unchanged.
  3. Test your integration with the new endpoints in a non-production tenant.
  4. Deploy the updated integration and remove any remaining calls to /api/v1/webhooks.

Both API paths use the same webhook resources. Existing webhooks, their IDs, and delivery history are preserved. You don’t need to recreate webhooks or migrate their data. Changing the API path also doesn’t affect webhook delivery payloads.

The following example shows the same request before and after migration:

Terminal window
# Deprecated
curl "https://<TENANT>.<REGION>.qlikcloud.com/api/v1/webhooks" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
# Replacement
curl "https://<TENANT>.<REGION>.qlikcloud.com/api/core/webhooks" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
Note

The qlik webhook commands in qlik-cli and the webhooks module in @qlik/api use the deprecated /api/v1/webhooks endpoints.

Namespaced replacements are not available in qlik-cli 3.4.0 or @qlik/api 2.20.0. Until replacements are available, use direct REST API requests to access /api/core/webhooks.

Watch this change log for updates to qlik-cli and @qlik/api.

Was this page helpful?