Sorry, no results found for "".

Show examples in:
Javascript HTTP
Endpoint info
Available examples

Content Management API > Build trigger

Update build trigger

Body parameters

name string Optional

Name of the build trigger

Example: "Custom build trigger"
adapter enum Optional

The type of build trigger

Example: "custom"
custom Optional

adapter_settings must include the following properties: trigger_url, headers and payload.

netlify Optional

adapter_settings must include the following properties: trigger_url, access_token, branch, site_id

vercel Optional

adapter_settings must include the following properties: project_id, token, branch, team_id, deploy_hook_url

circle_ci Optional

adapter_settings must include the following properties: project, token, revision, vcs, build_parameters

gitlab Optional

adapter_settings must include the following properties: trigger_url, token, ref, build_parameters

travis Optional

adapter_settings must include the following properties: api_token, repo, branch, config

indexing_enabled boolean Optional

Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content

frontend_url string, null Optional

The public URL of the frontend. If Site Search is enabled (indicated by indexing_enabled), this is the starting point from which the website's spidering will start

Example: "https://www.mywebsite.com/"
autotrigger_on_scheduled_publications boolean Optional

Wheter an automatic build request to webhook_url should be made on scheduled publications/unpublishings

adapter_settings object Optional

Additional settings for the build trigger. The value depends on the adapter.

Example: { trigger_url: "http://some-url.com/trigger", headers: { Authorization: "Bearer abc123" }, payload: { type: "build_request" }, }

Returns

Returns a resource object of type build_trigger

Examples

import { buildClient } from "@datocms/cma-client-node";
async function run() {
const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
const buildTriggerId = "1822";
const buildTrigger = await client.buildTriggers.update(buildTriggerId, {
id: "1822",
});
// Check the 'Returned output' tab for the result ☝️
console.log(buildTrigger);
}
run();
{
id: "1822",
name: "Custom build trigger",
adapter: "custom",
adapter_settings: {
trigger_url: "http://some-url.com/trigger",
headers: { Authorization: "Bearer abc123" },
payload: { type: "build_request" },
},
last_build_completed_at: "2017-03-30T09:29:14.872Z",
build_status: "success",
webhook_url: "https://webhooks.datocoms.com/xA1239ajsk123/deploy-results",
indexing_status: "success",
frontend_url: "https://www.mywebsite.com/",
indexing_enabled: true,
autotrigger_on_scheduled_publications: true,
}