Migration of API v2 users to API v3

For partners who have clients using API v2 integration, it is necessary to migrate them to API v3-supported integration.

Main migration steps:

  1. You need to create integration on API v3 and publish it on the Wazzup marketplace.
  2. When ready to migrate, use POST https://api.wazzup24.com/v3/migration to switch webhooks from API v2 to API v3.
  3. Start using API v3 methods for the selected users, instead of API v2 methods. Use for authorization the same client API key that was used for requests to API v2.

Method for switching webhooks API v2 to v3

To switch webhooks from API v2 to API v3 at a particular client, you need to call:

 POST https://api.wazzup24.com/v3/migration

In the header you need to pass the partner API key.

The body of the request must contain JSON with the values of the following parameters:

Parameter Type Description
clientApiKey String API key of the selected client, which was used to send API v2 requests
webhooksUri String URL, to which webhooks will be sent
subscriptions Object An object with subscriptions to two types of webhooks. Absence is similar to False
subscriptions.messagesAndStatuses Boolean Subscribing to webhooks about messages and their statuses
subscriptions.contactsAndDealsCreation Boolean Subscribing to webhooks about creating entities
Only one client can be migrated per query. If you have several clients, you need to make a query for every of them.