List source webhooks

sourceWebhooks(projectReference: ID!, input: SourceWebhooksInput): SourceWebhookList!

Requires project.agents.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject UUID or slug.
inputSourceWebhooksInputNo

Input fields

input

SourceWebhooksInput

FieldTypeRequiredDescription
sourceTargetKindWebhookSourceTargetKindNoThe source to read; default runtimeTargetKind, else project.
runtimeTargetKindWebhookRuntimeTargetKindNo
targetEnvironmentIdIDNoRequired with runtimeTargetKind environment.
targetBranchIdIDNoRequired with runtimeTargetKind preview_branch.

Response

Returns SourceWebhookList!. Open the type for its fields and nested types.

FieldTypeDescription
data[SourceWebhook!]!
diagnostics[ProjectSourceFileDiagnostic!]!
errors[ProjectSourceFileDiagnostic!]!Source files that could not be read or parsed.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query SourceWebhooks($projectReference: ID!, $input: SourceWebhooksInput) {
  sourceWebhooks(projectReference: $projectReference, input: $input) {
    data {
      id
      name
      definitionSource
      description
      editMode
    }
    diagnostics {
      code
      details
      kind
      message
      sourceId
    }
    errors {
      code
      details
      kind
      message
      sourceId
    }
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}