Content Management API > Build trigger

Build trigger

Configuration for different build triggers. You can have different staging and production environments in order to test your site before final deploy

Object payload

id string

ID of build_trigger

Example: "1822"

type string

Must be exactly "build_trigger".

name string

Name of the build trigger

Example: "Custom build trigger"

adapter enum

The type of build trigger

Example: "custom"

custom

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

netlify

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

vercel

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

circle_ci

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

gitlab

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

travis

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

adapter_settings object

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

last_build_completed_at

Timestamp of the last build

Type: date-time, null

Example: "2017-03-30T09:29:14.872Z"

build_status string

Status of last build

Example: "success"

webhook_url string

The URL of the webhook your service has to call when the build completes to report it's status (success or error)

Example: "https://webhooks.datocoms.com/xA1239ajsk123/deploy-results"

frontend_url string, null

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

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

webhook_token string

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

Example: "xA1239ajsk123"

indexing_status string Deprecated

Status of Site Search for the frontend

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

Example: "success"

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

Build trigger

Object payload

Available endpoints