Skip to main content
GET
List source webhooks

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required
Minimum string length: 1

Query Parameters

runtime_target_kind
enum<string> | null

Runtime target: main_branch, environment or preview_branch. Must match source_target_kind when both are sent.

Available options:
main_branch,
environment,
preview_branch,
null
target_environment_id
string<uuid> | null

Environment id, for the environment source target.

target_branch_id
string<uuid> | null

Branch id, for the preview_branch source target.

source_target_kind
enum<string>

Source to read: project, main_branch, environment or preview_branch. Defaults to runtime_target_kind, then main_branch.

Available options:
project,
main_branch,
environment,
preview_branch

Response

Webhooks declared in project source

data
object[]
required

Webhooks declared in project source files.

diagnostics
object[]
required

Source discovery diagnostics.

errors
object[]
required

Source files that could not be read or parsed.