> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get webhook

> Read one webhook by its ID to inspect its target, prompt template, event filter and status; returns the webhook with its public URL and never its secret.

`webhook(projectReference: ID!, webhookId: ID!): Webhook!`

Requires project.agents.read.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `projectReference` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | Project UUID or slug. |
| `webhookId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | The webhook id. A missing webhook fails with not\_found. |

## Response

Returns [`Webhook!`](https://veryfront.com/docs/cloud/graphql/types/webhook). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `id` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | The webhook id. Pass it as webhookId to the other webhook operations. |
| `projectId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | |
| `name` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `source` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Always webhook. |
| `target` | [`WebhookTarget!`](https://veryfront.com/docs/cloud/graphql/types/webhooktarget) | |
| `promptTemplate` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | Prompt template for run targets; null for an event-only webhook. |
| `eventFilter` | [`WebhookEventFilter`](https://veryfront.com/docs/cloud/graphql/types/webhookeventfilter) | Filter a delivery must match to run the target; null means always. |
| `status` | [`WebhookStatus!`](https://veryfront.com/docs/cloud/graphql/types/webhookstatus) | |

[All fields of `Webhook`](https://veryfront.com/docs/cloud/graphql/types/webhook).

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
query Webhook($projectReference: ID!, $webhookId: ID!) {
  webhook(projectReference: $projectReference, webhookId: $webhookId) {
    id
    projectId
    name
    status
    createdAt
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "webhookId": "00000000-0000-4000-8000-000000000001"
}
```

<details>
  <summary>Try this query</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Query

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.