Overview
This document aims to resolve the most commonly asked questions related to the recent updates to the Convertr Campaign Webhooks and Publisher APIs. If you have more complex questions, please reach out to our Support Team using the in-platform Platform Support icon on the top menu bar.
Related documents:
- Sending Leads To The Convertr Platform (Publisher API)
- POST Leads To The Convertr Platform (Campaign Webhook)
- Convertr API Rate Limits
FAQs
What version is the API?
At Convertr we don't version our APIs. We have simply added a new API to distinguish the Global Forms feature release.
What has changed?
With the rollout of the new Global Forms functionality, we upgraded our APIs. This is not a significant change to the API, however we have added a webhook URL which will return all the global forms linked to a specific campaign, rather than the campaign form Id which previously would have been returned. This is simply a change in the URL segment from “/form/” to “/global-form/”.
Do I have to make these changes?
Yes. If changes aren't made on your API then the lead delivery will no longer work as of the 9th November 2021. If you have any concerns please let us know using the Support details outlined in the Introduction of this document.
The old APIs will be deprecated as of 1st March 2022. Connections using this API will continue to work until this date.
Do I need to make changes to all of my current URLs?
No, for your current URLs that have been created before the 9th November 2021 the URLs do not need to be changed. Any APIs created after this date will need to have the new URL format.
Will the URLs for the forms be on Campaign level or Global level?
Form URLs will be on a campaign level. You'll create the URL “slug” on the global level but then when you assign it to a campaign it will have a specific URL for that campaign /forms/{campaignID}/slug
Existing tracking links and forms will continue to work without any action required, as we’ll automatically redirect the user to the new form location for backwards compatibility.