List webhooks

webhooks(projectReference: ID!, input: WebhooksInput): WebhookPage!

Requires project.agents.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject UUID or slug.
inputWebhooksInputNo

Input fields

input

WebhooksInput

FieldTypeRequiredDescription
limitIntNoMaximum webhooks to return, 1 to 100. Without limit and cursor every webhook is returned.
cursorIDNoThe previous page's pageInfo.endCursor. Keep sortOrder the same across pages.
sortOrderWebhookSortOrderNoCreation order; default desc (newest first). Ties break by id ascending.

Response

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

FieldType
data[Webhook!]!
pageInfoPageInfo!

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

Example

graphql
query Webhooks($projectReference: ID!, $input: WebhooksInput) {
  webhooks(projectReference: $projectReference, input: $input) {
    data {
      id
      projectId
      name
      status
      createdAt
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}