Auth

Retrieve Neon Auth webhook configuration

Returns the webhook configuration for the specified branch's Neon Auth integration, including the endpoint URL and the events that trigger it.

get/projects/{project_id}/branches/{branch_id}/auth/webhooks

Request

Base URL: https://console.neon.tech/api/v2
URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/auth/webhooks
Auth: one of:
- HTTP bearer
- API key in cookie zenith
- API key in cookie keycloak_token

Response

Returns webhook configuration for Neon Auth

enabledboolean required

Whether the webhook is active.

webhook_urlstring

Destination URL that receives webhook event payloads.

enabled_eventsstring[]

Event types that trigger this webhook. Covers user lifecycle, email/OTP delivery, organization invitations, and phone verification events; see the enum for exact values.

timeout_secondsinteger

Maximum time, in seconds, to wait for a response from the webhook endpoint.

Changes

No recorded changes to this operation across all 15 revisions of this API.