Upcoming Format Change to iFormBuilder Lookup Element
FeaturedOn August 1, 2023, we will be modifying the structure for Lookup element data from a stringified JSON object to native JSON. This change affects posting from iFormBuilder, meaning sending data to another service through Post Data Endpoints.
- This will break existing integrations that receive and parse iFormBuilder data that includes the Lookup element
- The format of the Lookup element will be consistent regardless of API method, API version, or JSON feed version
- The Lookup element will be consistent with other JSON-formatted elements (Multiphoto, HTTP Request)
The example below demonstrate the change in format:
Before:
{
"lookup": "{\"company\": \"Zerion\"}"
}
After:
{
"lookup": {
"company": "Zerion"
}
}
We urge all customers to review any existing integrations prior to the release.
———————————————————————————————————
Q: Who do these changes affect?
A: Customers with forms that have Lookup elements integrated with another application (Post Data Endpoint).
Q: Why are these changes happening?
A: The changes are necessary to normalize the data output for all versions of the API so downstream processing is simplified and consistent. This will also reduce parsing complexity as the output from these elements can be processed in their native format.
Q: How can I test the changes before it takes place in production?
A: To test these changes, get record data in a form that has a Lookup Element using the record resource API. The data returned will be in the format that will be made available on the scheduled release date. Use this in your code to determine what changes need to be made prior to the release.
Q: What API versions does this affect?
A: v.6, v.8 and v.8.1 Trigger Post Endpoints.
Q: What Post Data Endpoint JSON formats does it affect?
A: v.1, v.9 and v.10.
Q: Will this affect GET requests?
A: No, GET requests are already returned as JSON (v.6, v.8, v.8.1).
Please sign in to leave a comment.
Comments
0 comments