Update Neon Auth webhook configuration

PUT/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.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The Neon branch ID

pattern ^[a-z0-9-]{1,60}$

Request body

required

application/json

objectNeonAuthWebhookConfig

enabledbooleanrequired

Whether the webhook is active.

enabled_eventsarray of string

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

Show child attributes

timeout_secondsinteger

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

default 5 · maximum 10 · minimum 1

webhook_urlstring

Destination URL that receives webhook event payloads.

Example request

{
  "enabled": true,
  "enabled_events": [
    "organization.invitation.accepted"
  ],
  "timeout_seconds": 5,
  "webhook_url": "string"
}

Responses

objectNeonAuthWebhookConfig

enabledbooleanrequired

Whether the webhook is active.

enabled_eventsarray of string

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

Show child attributes

timeout_secondsinteger

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

default 5 · maximum 10 · minimum 1

webhook_urlstring

Destination URL that receives webhook event payloads.

Example response

{
  "enabled": true,
  "enabled_events": [
    "organization.invitation.accepted"
  ],
  "timeout_seconds": 5,
  "webhook_url": "string"
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

curl -X PUT 'https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"enabled_events":["organization.invitation.accepted"],"timeout_seconds":5,"webhook_url":"string"}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"enabled":true,"enabled_events":["organization.invitation.accepted"],"timeout_seconds":5,"webhook_url":"string"}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"enabled\":true,\"enabled_events\":[\"organization.invitation.accepted\"],\"timeout_seconds\":5,\"webhook_url\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks",
    headers={"Content-Type": "application/json"},
    data='{"enabled":true,"enabled_events":["organization.invitation.accepted"],"timeout_seconds":5,"webhook_url":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"enabled":true,"enabled_events":["organization.invitation.accepted"],"timeout_seconds":5,"webhook_url":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"enabled\":true,\"enabled_events\":[\"organization.invitation.accepted\"],\"timeout_seconds\":5,\"webhook_url\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"enabled\":true,\"enabled_events\":[\"organization.invitation.accepted\"],\"timeout_seconds\":5,\"webhook_url\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"enabled\":true,\"enabled_events\":[\"organization.invitation.accepted\"],\"timeout_seconds\":5,\"webhook_url\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://console.neon.tech/api/v2/projects/string/branches/string/auth/webhooks");
request.Content = new StringContent("{\"enabled\":true,\"enabled_events\":[\"organization.invitation.accepted\"],\"timeout_seconds\":5,\"webhook_url\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "enabled": true,
  "enabled_events": [
    "organization.invitation.accepted"
  ],
  "timeout_seconds": 5,
  "webhook_url": "string"
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}