Content Management API > Build trigger

Update build trigger

Body parameters

type string Required

Must be exactly "build_trigger".

attributes.name string Optional

Name of the build trigger

Example:

"Custom build trigger"

attributes.adapter enum Optional

The type of build trigger

Example:

"custom"

custom Optional

adapter_settings must include the following properties: trigger_url, headers and payload. The custom adapter also supports CircleCI webhooks for backward compatibility.

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

gitlab Optional

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

attributes.enabled boolean Optional

Whether the build trigger is enabled or not

attributes.frontend_url string, null Optional

The public URL of the frontend.

Example:

"https://www.mywebsite.com/"

attributes.autotrigger_on_scheduled_publications boolean Optional

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

attributes.adapter_settings object Optional

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

attributes.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

Site Search features have been detached from build triggers. This attribute has no effect anymore: we keep it present for retrocompatibility. If you're programmatically using this field, please get in touch with support@datocms.com

Returns

Returns a resource object of type build_trigger.

Examples

1
PUT https://site-api.datocms.com/build-triggers/:build_trigger_id HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6

7
{
8
  "data": {
9
    "type": "build_trigger",
10
    "id": "1822",
11
    "attributes": {}
12
  }
13
}

1
curl -g 'https://site-api.datocms.com/build-triggers/:build_trigger_id' \
2
  -X PUT \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3" \
6
  -H "Content-Type: application/vnd.api+json" \
7
  --data-binary '{"data":{"type":"build_trigger","id":"1822","attributes":{}}}'

1
await fetch("https://site-api.datocms.com/build-triggers/:build_trigger_id", {
2
  method: "PUT",
3
  headers: {
4
    Authorization: "Bearer YOUR-API-TOKEN",
5
    Accept: "application/json",
6
    "X-Api-Version": "3",
7
    "Content-Type": "application/vnd.api+json",
8
  },
9
  body: JSON.stringify({
10
    data: { type: "build_trigger", id: "1822", attributes: {} },
11
  }),
12
});

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "build_trigger",
10
    "id": "1822",
11
    "attributes": {
12
      "name": "Custom build trigger",
13
      "adapter": "custom",
14
      "adapter_settings": {
15
        "trigger_url": "http://some-url.com/trigger",
16
        "headers": {
17
          "Authorization": "Bearer abc123"
18
        },
19
        "payload": {
20
          "type": "build_request"
21
        }
22
      },
23
      "last_build_completed_at": "2017-03-30T09:29:14.872Z",
24
      "build_status": "success",
25
      "webhook_url": "https://webhooks.datocoms.com/xA1239ajsk123/deploy-results",
26
      "frontend_url": "https://www.mywebsite.com/",
27
      "enabled": true,
28
      "autotrigger_on_scheduled_publications": true
29
    }
30
  }
31
}

Update build trigger

Body parameters

Returns

Examples

HTTP Request

CURL Request

fetch() Request

HTTP Response