WhatsApp Business Platform > On-Premises API

We are sunsetting On-Premises API. Refer to our On-Premises API Sunset document for details, and to learn how to migrate to our next-generation Cloud API.

On-Premises API Changelog

Recommended version: v2.55.1

This changelog covers what has changed in the WhatsApp On-Premises API client and AWS/Azure/GCP Templates.

WhatsApp Business API Client

On-Premises API users must install new client versions to keep using the API without disruptions. Deprecated versions of the API client are not supported anymore. Should a client lose connection after the expiration date, the deprecated client will not be able to connect to the server and cannot send or receive messages.

The On-Premises client now offers support for MySQL 8. It is possible to migrate any version of the On-Premises client from MySQL 5 to MySQL 8. It's important to keep in mind that once a database has been migrated to MySQL 8, it is not possible to revert it back to MySQL 5. As a precaution, please ensure you create a backup of the database prior to initiating the migration process.

Warning: We are aware of an issue affecting GCP templates and MySQL 8. More information in our template github project.

Version	Date Introduced	Available Until
v2.55.1 (Recommended)	April 09, 2024	Oct 24, 2024
v2.53.2	Feb 06, 2024	July 25, 2024
v2.53.1	Jan 09, 2024	July 25, 2024
v2.51.3	Dec 21, 2023	April 25, 2024
v2.51.2	Nov 8, 2023	April 25, 2024
v2.51.1	Oct 10, 2023	April 25, 2024
v2.49.6	Nov 8, 2023	April 25, 2024
Archive

Troubleshooting & Known Issues

Please check the troubleshooting page for known issues.

WhatsApp On-Premises API Client Changes

April 09, 2024 (v2.55.1)

Version 2.55.1 is now available and includes:

Fix to prevent same media to be uploaded several times in particular scenarii.
Fix to prevent webhooks to be sent indefinitely if the webhook server on the business side is not available.

Feb 06, 2024 (v2.53.2)

Version 2.53.2 is now available and includes:

Fix "media not found" issue with outgoing media messages

Jan 09, 2024 (v2.53.1)

Version 2.53.1 is now available and includes:

A new crash logging system which saves dump files whenever a crash occurs [Crash Logs].
Bug Fixes.

Dec 21, 2023 (v2.51.3)

Please make sure to read the backwards incompatible changes for the v2.51 series before upgrading to this version.

Version 2.51.3 is now available and includes:

Fix db upgrade script, not running properly in v2.51.1 and v2.51.2.
Update on postgresql client on coreapp image.

Nov 8, 2023 (v2.51.2)

Please make sure to read the backwards incompatible changes for the v2.51 series before upgrading to this version.

Version 2.51.2 is now available and includes:

Greatly reduce docker image size (2GiB -> 600MiB).
Fix a crash that occurs on receiving an incoming message.
Upgrade several image packages, covering security vulnerabilities.
Fix a memory leak in 2.51.1 when using interactive messages.

Nov 8, 2023 (v2.49.6)

Version 2.49.6 is now available and includes:

Fix a crash that occurs on receiving an incoming message.
Upgrade several image packages, covering security vulnerabilities.

Oct 10, 2023 (v2.51.1)

Backwards incompatible changes for v2.51.*:

Starting with 2.51.1, the future API versions require AVX2 support. This excludes older AWS instance types that use PV AMIs (C1, C3, M1, M3, M2, and T1), VMWare ESXi 5.x and older, and CPUs older than Intel Haswell/AMD Zen1. The supported CPU flags can be checked at /proc/cpuinfo file.

Docker 20.10.10 and later is required due to a docker bug that prevents coreapp from starting.

Standalone DB upgrades are not currently supported in 2.51.1. Please skip the db upgrade step and deploy the updated version directly. There are no schema updates in this version from 2.49.

Version 2.51.1 is now available and includes:

You can now send WhatsApp Flows - see the Developer docs on how to get started.
On startup, coreapps will now process any pending offline messages before accepting outbound messages.
A new interactive message type named catalog_message has been introduced.

Amazon Web Services Templates

Current Version: 3.0.1

What's included in the Amazon Web Services (AWS) - Cloud Formation (CFN) templates:

Release Version Date Introduced Changes

Release Version	Date Introduced	Changes
`2.3.7`	Apr 26, 2022	Change details
`3.0.0`	Nov 18, 2022	Rework of Cloud Formation (CFN) templates Reduce the cost by host sharing shards at different throughputs Reduce the cost by scaling down shards / hosts
`3.0.1`	Aug 17, 2023	Update templates to use MySQL 8

2.3.7

Apr 26, 2022

Change details

3.0.0

Nov 18, 2022

Rework of Cloud Formation (CFN) templates

Reduce the cost by host sharing shards at different throughputs
Reduce the cost by scaling down shards / hosts

3.0.1

Aug 17, 2023

Update templates to use MySQL 8

GCP Deployment Templates

Current Version: 1.0.1

Release Version Date Introduced Changes

Release Version	Date Introduced	Changes
`1.0.0`	Nov 18, 2022	Rework of template Reduce the cost by host sharing shards at different throughputs Reduce the cost by scaling down shards / hosts
`1.0.1`	Aug 17, 2023	Update templates to use MySQL 8

1.0.0

Nov 18, 2022

Rework of template

Reduce the cost by host sharing shards at different throughputs
Reduce the cost by scaling down shards / hosts

1.0.1

Aug 17, 2023

Update templates to use MySQL 8

Azure Deployment Templates

Current Version: 1.0.1

Release Version Date Introduced Changes

Release Version	Date Introduced	Changes
`1.0.0`	Nov 18, 2022	Rework of template Reduce the cost by host sharing shards at different throughputs Reduce the cost by scaling down shards / hosts
`1.0.1`	Aug 17, 2023	Update templates to use MySQL 8

1.0.0

Nov 18, 2022

Rework of template

Reduce the cost by host sharing shards at different throughputs
Reduce the cost by scaling down shards / hosts

1.0.1

Aug 17, 2023

Update templates to use MySQL 8

WhatsApp Business Platform | Cloud API | On-Premises API | Business Management API