Sign in
Auth

Update Neon Auth webhook configuration

Updates the webhook configuration for the specified branch's Neon Auth integration. Webhooks notify an external endpoint when auth events occur, such as user creation or sign-in.

put/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

Request body

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.

Response

Returns the updated webhook configuration

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.