Builder has the ability to integrate with your app via webhooks. This can be useful if you want your app to listen for content changes that should trigger any workflows you might have on your end. An example of this might be to store the data that has changed in your database, or maybe to trigger a cache bust in your CDN.
Adding a webhook
To add a webhook for a model, go to the models page choose the model you want to edit. Then scroll down and choose "show advanced" then "edit webhooks." Enter a URL you would like us to POST to with the updated content. We will POST to the endpoint you provide every time content is published, unpublished, archived, or deleted. Note that a null "newValue" indicates a deletion, and a null "previousValue" indicates a first publish.
Rendering the data
Let's say you are using webhooks to store Builder content changes to use at render time, i.e. side-loading. Each time your app receives a webhook from Builder, your app stores the new value in its database. Then, when your app gets a request from a user, it queries its own database for the content instead of hitting the Builder API as requests come in.
If you are using the Builder React SDK to render components or pages on your site, pass the json data that came in the webhook (
newValue) to the content prop of the BuilderComponent and the component will handle rendering for you.
This approach can be extended or modified to fit your apps approach to rendering data for your users, even if you are not using the React SDK, or another Builder supplied SDK.
html that Builder generates, and then you can serve it to your users however you want to. When your app gets a webhook from Builder, use the
id supplied in the request to make a call to Builder's HTML API. Then store that HTML in your database and send it to your users however you want to. Note: Since in this case we are only calling Builder once every time your app receives a webhook, be sure to use the query parameter
cachebust=true to ensure your app gets the most up to date data.
Need Expert help?
Submit a project to our partners, BuildQuick, and be matched with a Builder expert.