---
title: "CreateWebhookEndpoint"
description: "Create a webhook endpoint"
canonical: "https://pgbeam.com/docs/go-sdk/webhooks/createWebhookEndpoint"
last-updated: "2026-10-30T13:45:52.000Z"
---

# CreateWebhookEndpoint

> Create a webhook endpoint

URL: https://pgbeam.com/docs/go-sdk/webhooks/createWebhookEndpoint

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Creates a webhook endpoint that receives project event deliveries.

## Usage

```go
result, err := client.Webhooks.CreateWebhookEndpoint(ctx, "prj_xxx", pgbeam.WebhookEndpointInput{
    Url: "https://example.com/hooks/pgbeam",
  })
```

## Parameters

| Parameter        | Type                                 | Required | Description                                               |
| ---------------- | ------------------------------------ | -------- | --------------------------------------------------------- |
| ctx              | `context.Context`                    | Yes      | Request context                                           |
| projectID        | `string`                             | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).       |
| body             | `pgbeam.WebhookEndpointInput`        | Yes      | Request body                                              |
| body.Url         | `string`                             | Yes      | HTTPS endpoint that receives event deliveries.            |
| body.Secret      | `*string`                            | No       | Shared secret used to sign delivery payloads. Write-only. |
| body.Format      | `*pgbeam.WebhookEndpointInputFormat` | No       | Payload format for delivered events.                      |
| body.EventTypes  | `*[]pgbeam.WebhookEventType`         | No       | Event types to deliver. Empty means all events.           |
| body.Enabled     | `*bool`                              | No       | Whether deliveries are active for this endpoint.          |
| body.Description | `*string`                            | No       | Human-readable label for the endpoint.                    |

## Response

`(*pgbeam.WebhookEndpoint, error)`: webhook endpoint created.

## Example

```go
import pgbeam "go.pgbeam.com/sdk"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pbu_...",
})

secret := "whsec_do-not-log-this"
format := pgbeam.WebhookEndpointInputFormat("json")
eventTypes := []pgbeam.WebhookEventType{"query_blocked", "canary_tripped"}
enabled := true
description := "Read-only access for the reporting agent"
result, err := client.Webhooks.CreateWebhookEndpoint(ctx, "prj_xxx", pgbeam.WebhookEndpointInput{
    Url: "https://example.com/hooks/pgbeam",
    Secret: &secret,
    Format: &format,
    EventTypes: &eventTypes,
    Enabled: &enabled,
    Description: &description,
  })
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                                                           |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status.                                 |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                                                               |
| 409    | The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for. |
| 413    | The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.                                                                                                                                                                                                                                                               |
| 415    | The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.                                                                                                                                                                                                                 |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                                                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                                                        |