/projects/{project_id}/branches/{branch_id}/auth/webhooksUpdate 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.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/webhooks" \
-X PUT \
-H "Authorization: Bearer $NEON_API_KEY"neon neon-auth config webhook update --enabledParameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Request body
1 required Required: enabled.
enabledWhether the webhook is active.
webhook_urlDestination URL that receives webhook event payloads.
enabled_eventsEvent types that trigger this webhook. Covers user lifecycle, email/OTP delivery, organization invitations, and phone verification events; see the enum for exact values.
timeout_secondsMaximum time, in seconds, to wait for a response from the webhook endpoint.
min: 1, max: 10
Response
200Returns the updated webhook configuration
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
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.