sites_build_hooks

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

Overview

Name	sites_build_hooks
Type	Resource
Id	netlify.build_hook.sites_build_hooks

Fields

The following fields are returned by SELECT queries:

getSiteBuildHook

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

listSiteBuildHooks

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
getSiteBuildHook	select	site_id, id
listSiteBuildHooks	select	site_id
createSiteBuildHook	insert	site_id
deleteSiteBuildHook	delete	site_id, id
updateSiteBuildHook	exec	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

getSiteBuildHook

OK

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

listSiteBuildHooks

OK

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

INSERT examples

createSiteBuildHook

No description available.

INSERT INTO netlify.build_hook.sites_build_hooks (
data__branch,
data__title,
site_id
)
SELECT 
'{{ branch }}',
'{{ title }}',
'{{ site_id }}'
RETURNING
id,
site_id,
branch,
created_at,
title,
url
;

Manifest

# Description fields are for documentation purposes
- name: sites_build_hooks
  props:
    - name: site_id
      value: string
      description: Required parameter for the sites_build_hooks resource.
    - name: branch
      value: string
    - name: title
      value: string

DELETE examples

deleteSiteBuildHook

No description available.

DELETE FROM netlify.build_hook.sites_build_hooks
WHERE site_id = '{{ site_id }}' --required
AND id = '{{ id }}' --required
;

Lifecycle Methods

updateSiteBuildHook

No content

EXEC netlify.build_hook.sites_build_hooks.updateSiteBuildHook 
@site_id='{{ site_id }}' --required, 
@id='{{ id }}' --required 
@@json=
'{
"branch": "{{ branch }}", 
"title": "{{ title }}"
}'
;