# Set a unique key once per new action; persist it and reuse it for every retry.
: "${REFLECTIONS_KEY:?Set REFLECTIONS_KEY before running this example}"
: "${REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY:?Set REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY before running this example}"
curl --fail-with-body --max-time 30 -X POST 'https://app.reflections.ai/v1/webhook_endpoints' \
-H "Authorization: Bearer $REFLECTIONS_KEY" \
-H "Reflections-Version: 2026-10-15" \
-H "Idempotency-Key: $REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY" \
-H "Content-Type: application/json" \
--data-raw '{
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated"
],
"description": "Production",
"connected": true
}'import { env, exit } from "node:process";
// Set a unique key once per new action; persist it and reuse it for every retry.
const apiKey = env.REFLECTIONS_KEY;
if (!apiKey) throw new Error("Set REFLECTIONS_KEY before running this example");
const idempotencyKey = env.REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY;
if (!idempotencyKey) throw new Error("Set REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY before running this example");
const response = await fetch("https://app.reflections.ai/v1/webhook_endpoints", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Reflections-Version": "2026-10-15",
"Idempotency-Key": idempotencyKey,
"Content-Type": "application/json",
},
body: JSON.stringify({
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated"
],
"description": "Production",
"connected": true
}),
signal: AbortSignal.timeout(30_000),
});
const responseBody = await response.text();
if (!response.ok) {
console.error(`HTTP ${response.status}: ${responseBody}`);
exit(1);
}
console.log(responseBody);
import json
import os
from urllib.error import HTTPError
from urllib.request import Request, urlopen
# Set a unique key once per new action; persist it and reuse it for every retry.
apiKey = os.environ["REFLECTIONS_KEY"]
if not apiKey:
raise ValueError("Set REFLECTIONS_KEY before running this example")
idempotencyKey = os.environ["REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY"]
if not idempotencyKey:
raise ValueError("Set REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY before running this example")
headers = {
"Authorization": f"Bearer {apiKey}",
"Reflections-Version": "2026-10-15",
"Idempotency-Key": idempotencyKey,
"Content-Type": "application/json",
}
data = json.dumps({
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated",
],
"description": "Production",
"connected": True,
}).encode("utf-8")
request = Request("https://app.reflections.ai/v1/webhook_endpoints",
method="POST", headers=headers, data=data)
try:
with urlopen(request, timeout=30) as response:
print(response.read().decode("utf-8"))
except HTTPError as error:
error_body = error.read().decode("utf-8")
raise RuntimeError(f"HTTP {error.code}: {error_body}") from error
package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
"time"
)
func main() {
// Set a unique key once per new action; persist it and reuse it for every retry.
apiKey := os.Getenv("REFLECTIONS_KEY")
if apiKey == "" {
panic("Set REFLECTIONS_KEY before running this example")
}
idempotencyKey := os.Getenv("REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY")
if idempotencyKey == "" {
panic("Set REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY before running this example")
}
body := strings.NewReader(`{
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated"
],
"description": "Production",
"connected": true
}`)
request, err := http.NewRequest("POST", "https://app.reflections.ai/v1/webhook_endpoints", body)
if err != nil {
panic(err)
}
request.Header.Set("Authorization", "Bearer " + apiKey)
request.Header.Set("Reflections-Version", "2026-10-15")
request.Header.Set("Idempotency-Key", idempotencyKey)
request.Header.Set("Content-Type", "application/json")
client := &http.Client{Timeout: 30 * time.Second}
response, err := client.Do(request)
if err != nil {
panic(err)
}
defer response.Body.Close()
responseBody, err := io.ReadAll(response.Body)
if err != nil {
panic(err)
}
if response.StatusCode < 200 || response.StatusCode >= 300 {
panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, responseBody))
}
fmt.Print(string(responseBody))
}
{
"id": "we_5x7z9b1d3f5h7k9m1p3r5t7v9x",
"object": "webhook_endpoint",
"livemode": true,
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated"
],
"description": "Production",
"status": "enabled",
"disabled_reason": null,
"api_version": "2026-10-15",
"connected": true,
"secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw",
"metadata": {},
"created_at": "2026-10-17T17:40:00Z"
}{
"type": "https://docs.reflections.ai/errors/parameter_invalid",
"title": "A parameter is invalid",
"status": 400,
"code": "parameter_invalid",
"param": "use.territories[1]",
"detail": "\"UK\" is not an ISO 3166-1 alpha-2 code. Use \"GB\".",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/invalid_api_key",
"title": "The API key is not valid",
"status": 401,
"code": "invalid_api_key",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/account_not_connected",
"title": "The licensee has not connected your platform",
"status": 403,
"code": "account_not_connected",
"detail": "acct_2q8v1m3n7p4r6s9t0wxyhk5zba has no active connection with your account.",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/idempotency_key_in_use",
"title": "A request with this key is still running",
"status": 409,
"code": "idempotency_key_in_use",
"detail": "Retry with the same key after a short wait.",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/idempotency_key_reused",
"title": "This key was used for a different request",
"status": 422,
"code": "idempotency_key_reused",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/rate_limited",
"title": "Too many requests",
"status": 429,
"code": "rate_limited",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "invalid_request",
"request_id": "<string>",
"detail": "<string>",
"param": "<string>",
"doc_url": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "invalid_request",
"request_id": "<string>",
"detail": "<string>",
"param": "<string>",
"doc_url": "<string>"
}Create a webhook endpoint
Planned contract — unavailable in test and live modes. This operation is a protocol reference, not a callable endpoint. Start with the working sandbox quickstart.
Registers an HTTPS URL to receive events. The response includes the signing secret once;
store it. Events are signed with the Standard Webhooks scheme.
Restricted keys need webhooks:manage.
# Set a unique key once per new action; persist it and reuse it for every retry.
: "${REFLECTIONS_KEY:?Set REFLECTIONS_KEY before running this example}"
: "${REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY:?Set REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY before running this example}"
curl --fail-with-body --max-time 30 -X POST 'https://app.reflections.ai/v1/webhook_endpoints' \
-H "Authorization: Bearer $REFLECTIONS_KEY" \
-H "Reflections-Version: 2026-10-15" \
-H "Idempotency-Key: $REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY" \
-H "Content-Type: application/json" \
--data-raw '{
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated"
],
"description": "Production",
"connected": true
}'import { env, exit } from "node:process";
// Set a unique key once per new action; persist it and reuse it for every retry.
const apiKey = env.REFLECTIONS_KEY;
if (!apiKey) throw new Error("Set REFLECTIONS_KEY before running this example");
const idempotencyKey = env.REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY;
if (!idempotencyKey) throw new Error("Set REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY before running this example");
const response = await fetch("https://app.reflections.ai/v1/webhook_endpoints", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Reflections-Version": "2026-10-15",
"Idempotency-Key": idempotencyKey,
"Content-Type": "application/json",
},
body: JSON.stringify({
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated"
],
"description": "Production",
"connected": true
}),
signal: AbortSignal.timeout(30_000),
});
const responseBody = await response.text();
if (!response.ok) {
console.error(`HTTP ${response.status}: ${responseBody}`);
exit(1);
}
console.log(responseBody);
import json
import os
from urllib.error import HTTPError
from urllib.request import Request, urlopen
# Set a unique key once per new action; persist it and reuse it for every retry.
apiKey = os.environ["REFLECTIONS_KEY"]
if not apiKey:
raise ValueError("Set REFLECTIONS_KEY before running this example")
idempotencyKey = os.environ["REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY"]
if not idempotencyKey:
raise ValueError("Set REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY before running this example")
headers = {
"Authorization": f"Bearer {apiKey}",
"Reflections-Version": "2026-10-15",
"Idempotency-Key": idempotencyKey,
"Content-Type": "application/json",
}
data = json.dumps({
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated",
],
"description": "Production",
"connected": True,
}).encode("utf-8")
request = Request("https://app.reflections.ai/v1/webhook_endpoints",
method="POST", headers=headers, data=data)
try:
with urlopen(request, timeout=30) as response:
print(response.read().decode("utf-8"))
except HTTPError as error:
error_body = error.read().decode("utf-8")
raise RuntimeError(f"HTTP {error.code}: {error_body}") from error
package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
"time"
)
func main() {
// Set a unique key once per new action; persist it and reuse it for every retry.
apiKey := os.Getenv("REFLECTIONS_KEY")
if apiKey == "" {
panic("Set REFLECTIONS_KEY before running this example")
}
idempotencyKey := os.Getenv("REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY")
if idempotencyKey == "" {
panic("Set REFLECTIONS_CREATE_WEBHOOK_ENDPOINT_IDEMPOTENCY_KEY before running this example")
}
body := strings.NewReader(`{
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated"
],
"description": "Production",
"connected": true
}`)
request, err := http.NewRequest("POST", "https://app.reflections.ai/v1/webhook_endpoints", body)
if err != nil {
panic(err)
}
request.Header.Set("Authorization", "Bearer " + apiKey)
request.Header.Set("Reflections-Version", "2026-10-15")
request.Header.Set("Idempotency-Key", idempotencyKey)
request.Header.Set("Content-Type", "application/json")
client := &http.Client{Timeout: 30 * time.Second}
response, err := client.Do(request)
if err != nil {
panic(err)
}
defer response.Body.Close()
responseBody, err := io.ReadAll(response.Body)
if err != nil {
panic(err)
}
if response.StatusCode < 200 || response.StatusCode >= 300 {
panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, responseBody))
}
fmt.Print(string(responseBody))
}
{
"id": "we_5x7z9b1d3f5h7k9m1p3r5t7v9x",
"object": "webhook_endpoint",
"livemode": true,
"url": "https://northlight.example/webhooks/reflections",
"events": [
"check.resolved",
"generation.released",
"generation.denied",
"revocation.created",
"session.terminated"
],
"description": "Production",
"status": "enabled",
"disabled_reason": null,
"api_version": "2026-10-15",
"connected": true,
"secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw",
"metadata": {},
"created_at": "2026-10-17T17:40:00Z"
}{
"type": "https://docs.reflections.ai/errors/parameter_invalid",
"title": "A parameter is invalid",
"status": 400,
"code": "parameter_invalid",
"param": "use.territories[1]",
"detail": "\"UK\" is not an ISO 3166-1 alpha-2 code. Use \"GB\".",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/invalid_api_key",
"title": "The API key is not valid",
"status": 401,
"code": "invalid_api_key",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/account_not_connected",
"title": "The licensee has not connected your platform",
"status": 403,
"code": "account_not_connected",
"detail": "acct_2q8v1m3n7p4r6s9t0wxyhk5zba has no active connection with your account.",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/idempotency_key_in_use",
"title": "A request with this key is still running",
"status": 409,
"code": "idempotency_key_in_use",
"detail": "Retry with the same key after a short wait.",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/idempotency_key_reused",
"title": "This key was used for a different request",
"status": 422,
"code": "idempotency_key_reused",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "https://docs.reflections.ai/errors/rate_limited",
"title": "Too many requests",
"status": 429,
"code": "rate_limited",
"request_id": "req_8f2k4m6p8r0t2v4x6z8b0d2f4h"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "invalid_request",
"request_id": "<string>",
"detail": "<string>",
"param": "<string>",
"doc_url": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "invalid_request",
"request_id": "<string>",
"detail": "<string>",
"param": "<string>",
"doc_url": "<string>"
}Authorizations
Your secret key, rk_test_… or rk_live_…, sent as Authorization: Bearer <key>. Keep it
on your server. Restricted keys carry only the scopes you give them.
Headers
The dated API version. Defaults to the version your account is pinned to.
"2026-10-15"
A unique key for this operation, up to 255 characters. In test mode, POST keys are scoped to your account and mode and bind the endpoint and body for 24 hours. A different endpoint or body with the same key is refused.
Initial live check and generation creation require a nonempty key. Each operation has a
separate account-scoped namespace; retain the same API key, body and idempotency key for
retries within 24 hours of creation. A pending check returns 202 with status: "checking".
Completed checks replay their sealed response; successful generation POSTs replay the
original accepted 202, so use GET for current state. Live verification is a read-only
query that returns a fresh verification ID on each call, without exact response caching.
The broader delegated-account contract also scopes keys to Reflections-Account;
delegated requests and the other planned live POST operations remain unsupported.
255Body
An HTTPS URL.
Event types to send, or ["*"] for all.
1license.issued, license.accepted, license.revised, license.revision_pending, license.revision_declined, license.suspended, license.resumed, license.revoked, license.expired, license.declined, license_request.created, license_request.signed, license_request.declined, license_draft.signed, license_draft.declined, check.resolved, escalation.created, generation.allowed, generation.released, generation.denied, generation.expired, session.terminated, revocation.created, revocation.overdue, connection.created, connection.revoked, facet.updated, talent.updated, statement.issued, statement.disputed, mandate.created, mandate.ended, webhook_endpoint.disabled Your label for the endpoint, such as Production.
500The version events are rendered in. Defaults to your account's version.
Also send events about connected licensees' objects.
Keys and values of your own, returned on the endpoint.
Show child attributes
Show child attributes
Response
The endpoint, with its secret.
The endpoint's ID, we_….
^we_[0-9a-hjkmnp-tv-z]{26}$Always webhook_endpoint.
"webhook_endpoint"true for an endpoint created with a live key, which receives only live events. false
for one created with a test key, which receives only test events.
The HTTPS URL events are sent to.
The event types sent to this endpoint. ["*"] sends every type, including types added
later.
license.issued, license.accepted, license.revised, license.revision_pending, license.revision_declined, license.suspended, license.resumed, license.revoked, license.expired, license.declined, license_request.created, license_request.signed, license_request.declined, license_draft.signed, license_draft.declined, check.resolved, escalation.created, generation.allowed, generation.released, generation.denied, generation.expired, session.terminated, revocation.created, revocation.overdue, connection.created, connection.revoked, facet.updated, talent.updated, statement.issued, statement.disputed, mandate.created, mandate.ended, webhook_endpoint.disabled enabled, or disabled after every delivery failed for 5 days. Re-enable a disabled
endpoint by updating it with status: enabled.
enabled, disabled The version events are rendered in. Set when the endpoint is created; it cannot be changed.
When the endpoint was created.
Your label for the endpoint. null when you set none.
Why Reflections disabled the endpoint. null while enabled.
Whether the endpoint also receives events about connected licensees' objects. Those
events carry the licensee's ID in account.
whsec_…. Returned only when the endpoint is created or its secret rotated.
Keys and values of your own.
Show child attributes
Show child attributes