Home
Content Management API
Main resources
Upload-related
Site Search
Environments
UI
Workflows
Async jobs
Roles & permissions
Webhooks
Hosting & CI integrations
Subscription
Enterprise
Show examples in:
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
type  string
Must be exactly "build_trigger"
name  string  Example: "Custom build trigger"

Name of the build trigger

adapter  enum  Example: "custom"

The type of build trigger

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

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

last_build_completed_at  date-time, null  Example: "2017-03-30T09:29:14.872Z"

Timestamp of the last build

build_status  string  Example: "success"

Status of last build

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

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

indexing_status  string  Example: "success"

Status of Site Search for the frontend

frontend_url  string, null  Example: "https://www.mywebsite.com/"

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

indexing_enabled  boolean  Example: true

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

autotrigger_on_scheduled_publications  boolean  Example: true

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

webhook_token  string  Example: "xA1239ajsk123"

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

Available endpoints

Did this doc help you?
Still 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.