build_hooks

Creates, updates, deletes, gets or lists a build_hooks resource.

Overview

Name	build_hooks
Type	Resource
Id	netlify.builds.build_hooks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string
site_id	string
branch	string
created_at	string (dateTime)
title	string
url	string

list

Name	Datatype	Description
id	string
site_id	string
branch	string
created_at	string (dateTime)
title	string
url	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	site_id, id
list	select	site_id
create	insert	site_id
update	replace	site_id, id
delete	delete	site_id, id

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string
site_id	string

SELECT examples

get

OK

SELECT
id,
site_id,
branch,
created_at,
title,
url
FROM netlify.builds.build_hooks
WHERE site_id = '{{ site_id }}' -- required
AND id = '{{ id }}' -- required
;

list

OK

SELECT
id,
site_id,
branch,
created_at,
title,
url
FROM netlify.builds.build_hooks
WHERE site_id = '{{ site_id }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO netlify.builds.build_hooks (
title,
branch,
site_id
)
SELECT 
'{{ title }}',
'{{ branch }}',
'{{ site_id }}'
RETURNING
id,
site_id,
branch,
created_at,
title,
url
;

Manifest

# Description fields are for documentation purposes
- name: build_hooks
props:
  - name: site_id
    value: "{{ site_id }}"
    description: Required parameter for the build_hooks resource.
  - name: title
    value: "{{ title }}"
  - name: branch
    value: "{{ branch }}"

REPLACE examples

update

No description available.

REPLACE netlify.builds.build_hooks
SET 
title = '{{ title }}',
branch = '{{ branch }}'
WHERE 
site_id = '{{ site_id }}' --required
AND id = '{{ id }}' --required;

DELETE examples

delete

No description available.

DELETE FROM netlify.builds.build_hooks
WHERE site_id = '{{ site_id }}' --required
AND id = '{{ id }}' --required
;