diff --git a/Changelog.md b/Changelog.md index 3be6a1c2e..236fe55c3 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,5 +1,9 @@ # Changelog +## 20240130 + +Update to the API version upgrades article regarding the v2024-01-01 webhook version. + ## 20240117 Quick fix to the CSV export with API article. diff --git a/docs/guides/development/API-Version-Upgrades.md b/docs/guides/development/API-Version-Upgrades.md index 8eea48d5d..92a5e50dd 100644 --- a/docs/guides/development/API-Version-Upgrades.md +++ b/docs/guides/development/API-Version-Upgrades.md @@ -34,11 +34,12 @@ If you’re running an older version, you’ll want to upgrade to take advantage ## API changelog -| Version | Description | -|:---|:---| -| v2017-04-05
version deprecated | - Responses from the voucher and campaign listing methods were moved to the new object structure. Methods will now render specific properties for a total count and an array of objects.
- Introduced validation for listing parameters: `limit` and `page`. A limit can range between 1 and 100 items.
- Get voucher/campaign methods render **validation rules** related to the voucher object. They can be inherited from a campaign.
- Created an API method for getting a campaign identified by name. | -| v2017-04-20
version deprecated | Response from the voucher publish method was moved to the new object structure. Returned voucher details are wrapped by transaction object describing publication event:
{ "id": "pub_whQzIndYoyZoqiLEKN0s04GK", "object": "publication", "created_at": "2017-04-20T13:18:01Z", "customer_id": "cust_mOjhGypfbqch0v3DpAA9LDXj", "tracking_id": "janusz", "channel": "API", "metadata": { "test":true }, "voucher": {} } | -| v2018-08-01 | This version introduces a new model for building Validation Rules. The extended mechanism gives an advanced configuration for making promo conditions.

The modifications in this version affect the following API methods:

- `List Promotion Tiers`: replaced an object describing conditions by a list of records describing an association between rule and tier - `validation_rule_assignments`
- `List Promotion Tiers for campaign` - as above
- `Promotion Tier Object` - as above
- `Validation Rule Object` - structure reorganized to handle advanced rules
- `Validation Rule Assignment Object` - added object describing a relation between rules and linked promotions
- `Validation Rules` - modified data model

The mechanics and details of Validation Rules builder are described in the Help Center. | +| Version | Description | +| :--------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| v2017-04-05
version deprecated | - Responses from the voucher and campaign listing methods were moved to the new object structure. Methods will now render specific properties for a total count and an array of objects.
- Introduced validation for listing parameters: `limit` and `page`. A limit can range between 1 and 100 items.
- Get voucher/campaign methods render **validation rules** related to the voucher object. They can be inherited from a campaign.
- Created an API method for getting a campaign identified by name. | +| v2017-04-20
version deprecated | Response from the voucher publish method was moved to the new object structure. Returned voucher details are wrapped by transaction object describing publication event:
{ "id": "pub_whQzIndYoyZoqiLEKN0s04GK", "object": "publication", "created_at": "2017-04-20T13:18:01Z", "customer_id": "cust_mOjhGypfbqch0v3DpAA9LDXj", "tracking_id": "janusz", "channel": "API", "metadata": { "test":true }, "voucher": {} } | +| v2018-08-01 | This version introduces a new model for building Validation Rules. The extended mechanism gives an advanced configuration for making promo conditions.

The modifications in this version affect the following API methods:

- `List Promotion Tiers`: replaced an object describing conditions by a list of records describing an association between rule and tier - `validation_rule_assignments`
- `List Promotion Tiers for campaign` - as above
- `Promotion Tier Object` - as above
- `Validation Rule Object` - structure reorganized to handle advanced rules
- `Validation Rule Assignment Object` - added object describing a relation between rules and linked promotions
- `Validation Rules` - modified data model

The mechanics and details of Validation Rules builder are described in the Help Center. | +| Webhooks v2024-01-01 | In [v20231205](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20231205) release, a new version of webhooks was introduced. The new webhooks are available for distribution and the events listed in Project settings. There, you can switch from the old v2018-01-01 webhook version to the new one. The accounts created after the v20231205 release can use only the new version. | > 📘 Release Notes >