Create build trigger — Build trigger

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

adapter_settings Required 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.

autotrigger_on_scheduled_publications Required boolean Example: true

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

webhook_token Optional string Example: "xA1239ajsk123"

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

Returns

Returns a build_trigger resource object.

Examples

Example Basic example

import { buildClient } from '@datocms/cma-client-node';
async function run() {
  const client = buildClient({ apiToken: '<YOUR_API_TOKEN>' });
  
  const buildTrigger = await client.buildTriggers.create({
    name: 'Custom build trigger',
    adapter: 'custom',
    indexing_enabled: true,
    frontend_url: 'https://www.mywebsite.com/',
    adapter_settings: {
      trigger_url: 'http://some-url.com/trigger',
      headers: {
        Authorization: 'Bearer abc123'
      },
      payload: {
        type: 'build_request'
      }
    },
    autotrigger_on_scheduled_publications: true
  });
  
  console.log(buildTrigger);
}
run();

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.