hooks

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

Overview

Name	hooks
Type	Resource
Id	netlify.hook.hooks

Fields

The following fields are returned by SELECT queries:

getHook

Name	Datatype	Description
id	string
site_id	string
created_at	string (dateTime)
data	object
disabled	boolean
event	string
type	string
updated_at	string (dateTime)

listHooksBySiteId

Name	Datatype	Description
id	string
site_id	string
created_at	string (dateTime)
data	object
disabled	boolean
event	string
type	string
updated_at	string (dateTime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getHook	select	hook_id
listHooksBySiteId	select	site_id
createHookBySiteId	insert	site_id
deleteHook	delete	hook_id
updateHook	exec	hook_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
hook_id	string
site_id	string

SELECT examples

getHook

OK

SELECT
id,
site_id,
created_at,
data,
disabled,
event,
type,
updated_at
FROM netlify.hook.hooks
WHERE hook_id = '{{ hook_id }}' -- required
;

listHooksBySiteId

OK

SELECT
id,
site_id,
created_at,
data,
disabled,
event,
type,
updated_at
FROM netlify.hook.hooks
WHERE site_id = '{{ site_id }}' -- required
;

INSERT examples

createHookBySiteId

No description available.

INSERT INTO netlify.hook.hooks (
data__created_at,
data__data,
data__disabled,
data__event,
data__id,
data__site_id,
data__type,
data__updated_at,
site_id
)
SELECT 
'{{ created_at }}',
'{{ data }}',
{{ disabled }},
'{{ event }}',
'{{ id }}',
'{{ site_id }}',
'{{ type }}',
'{{ updated_at }}',
'{{ site_id }}'
RETURNING
id,
site_id,
created_at,
data,
disabled,
event,
type,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: hooks
  props:
    - name: site_id
      value: string
      description: Required parameter for the hooks resource.
    - name: created_at
      value: string
    - name: data
      value: object
    - name: disabled
      value: boolean
    - name: event
      value: string
    - name: id
      value: string
    - name: site_id
      value: string
    - name: type
      value: string
    - name: updated_at
      value: string

DELETE examples

deleteHook

No description available.

DELETE FROM netlify.hook.hooks
WHERE hook_id = '{{ hook_id }}' --required
;

Lifecycle Methods

updateHook

OK

EXEC netlify.hook.hooks.updateHook 
@hook_id='{{ hook_id }}' --required 
@@json=
'{
"created_at": "{{ created_at }}", 
"data": "{{ data }}", 
"disabled": {{ disabled }}, 
"event": "{{ event }}", 
"id": "{{ id }}", 
"site_id": "{{ site_id }}", 
"type": "{{ type }}", 
"updated_at": "{{ updated_at }}"
}'
;