vcs_webhooks

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

Overview

Name	vcs_webhooks
Type	Resource
Id	ovh.hosting_web.vcs_webhooks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
push	string	Webhook URL for push events

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	path, service_name, vcs		Returns the webhook URL to call on push events to deploy a website. Filter it by hosting path and VCS platform.

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
path	string	Filter on hosting path
service_name	string	Service name (wire: serviceName)
vcs	string	Filter on VCS platform

SELECT examples

get

Returns the webhook URL to call on push events to deploy a website. Filter it by hosting path and VCS platform.

SELECT
push
FROM ovh.hosting_web.vcs_webhooks
WHERE path = '{{ path }}' -- required
AND service_name = '{{ service_name }}' -- required
AND vcs = '{{ vcs }}' -- required
;