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 Deprecated

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

We'll soon detach Site Search features from build trigger. If you're programmatically using this field, please get in touch with support@datocms.com

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
    frontend_url: "https://www.mywebsite.com/",
10
    adapter_settings: {
11
      trigger_url: "http://some-url.com/trigger",
12
      headers: { Authorization: "Bearer abc123" },
13
      payload: { type: "build_request" },
14
    },
15
    autotrigger_on_scheduled_publications: true,
16
  });
17

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

22
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
  frontend_url: "https://www.mywebsite.com/",
14
  autotrigger_on_scheduled_publications: true,
15
}

Create build trigger

Body parameters

Returns

Examples

Code

Returned output