Update Neon Auth webhook configuration

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

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.

Markdown for AI context

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/webhooks" \
  -X PUT \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

neon neon-auth config webhook update --enabled

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

1 required Required: enabled.

Enabled

enabled

boolean

Whether the webhook is active.

Webhook url

webhook_url

string

Destination URL that receives webhook event payloads.

Enabled events

enabled_events

array

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 seconds

timeout_seconds

integerdefault: 5

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

12345678910

min: 1, max: 10

200

Returns the updated webhook configuration

"enabled": (boolean),req

"webhook_url": (string),

"enabled_events": (array),

"timeout_seconds": 5,1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10min: 1, max: 10

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.