You can integrate Builder with your app using webhooks. This can be useful if you want your app to be aware of content changes that should trigger any workflows you have on your end. An example of this could include storing the data that has changed in your database or triggering a cache bust in your CDN.
To add a webhook for a model:
- Go to Models.
- Choose the model you want to edit.
- Scroll down and choose Show More Options.
- Click Edit Webhooks.
- Enter a URL you would like Builder to
POSTto with the updated content.
Builder 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.
The following is an example of a POST format:
{
"newValue": {
"id": "cs3df",
"published": "draft",
"name": "My great page",
"data": {
"property": "value"
}
},
"previousValue": { ... }
}The following example demonstrates rendering data.
Suppose you were using webhooks to store Builder content changes to use at render time; for example, side-loading. Each time your app received a webhook from Builder, your app would store the new value in its database.
Then, when your app received a request from a user, it would query its own database for the content instead of hitting the Builder API as requests came in.
If you were using the Builder React SDK to render components or pages on your site, you'd pass the JSON data that came in the webhook,newValue, to the content prop of the BuilderComponent and the component would handle rendering for you, as in the snippet below:
import { BuilderComponent } from '@builder.io/react';
<BuilderComponent model="page" content={theJsonFromTheWebhook} />You can extend or modify this approach to fit your app's way of rendering data for your users, even if you are not using a Builder-supplied SDK.
Another option if you are not using JavaScript to render your frontend is to have Builder pre-render the HTML for you. Using pre-rendering means you can store the HTML that Builder generates and serve it to your users according to your use case.
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 in a way that works for your app.
Since this example only calls Builder once every time the app receives a webhook, use the query parameter cachebust=true to ensure your app gets the most up-to-date data. The response below uses cachebust=true:
let response = fetch('https://cdn.builder.io/api/v1/html/DOC_ID?apiKey=YOUR_KEY&cachebust=true')
// Now you can save and later serve the HTML as you please
let html = response.data.htmlTip: Only use cachebust: true in the SDKs or APIs for build time requests; such as static building pages.
We do not recommend it for runtime requests—such as when serving live pages.
Looking to hire a third party to help with your project?
Submit a project request and our partnerships team will reach out to connect you with an Expert from our partner ecosystem.
