Content Management API > Build trigger

Create build trigger

Body parameters

name string Required

Name of the build trigger

Example:

"Custom build trigger"

adapter enum Required

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 Required

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 Required

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/"

adapter_settings object Required

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" },
}

autotrigger_on_scheduled_publications boolean Required

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

webhook_token string Optional

Unique token for the webhook (it's the same token present in webhook_url)

Example:

"xA1239ajsk123"

Returns

Returns a resource object of type build_trigger

Examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  const buildTrigger = await client.buildTriggers.create({
7
    name: "Custom build trigger",
8
    adapter: "custom",
9
    indexing_enabled: true,
10
    frontend_url: "https://www.mywebsite.com/",
11
    adapter_settings: {
12
      trigger_url: "http://some-url.com/trigger",
13
      headers: { Authorization: "Bearer abc123" },
14
      payload: { type: "build_request" },
15
    },
16
    autotrigger_on_scheduled_publications: true,
17
  });
18

19
  // Check the 'Returned output' tab for the result ☝️
20
  console.log(buildTrigger);
21
}
22

23
run();

1
{
2
  id: "1822",
3
  name: "Custom build trigger",
4
  adapter: "custom",
5
  adapter_settings: {
6
    trigger_url: "http://some-url.com/trigger",
7
    headers: { Authorization: "Bearer abc123" },
8
    payload: { type: "build_request" },
9
  },
10
  last_build_completed_at: "2017-03-30T09:29:14.872Z",
11
  build_status: "success",
12
  webhook_url: "https://webhooks.datocoms.com/xA1239ajsk123/deploy-results",
13
  indexing_status: "success",
14
  frontend_url: "https://www.mywebsite.com/",
15
  indexing_enabled: true,
16
  autotrigger_on_scheduled_publications: true,
17
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.