Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Reflections-Version
string

The dated API version. Defaults to the version your account is pinned to.

Example:

"2026-10-15"

Path Parameters

endpoint_id
string
required

The endpoint's ID.

Pattern: ^we_[0-9a-hjkmnp-tv-z]{26}$

Response

The endpoint.

id
string
required

The endpoint's ID, we_….

Pattern: ^we_[0-9a-hjkmnp-tv-z]{26}$
object
string
required

Always webhook_endpoint.

Allowed value: "webhook_endpoint"
livemode
boolean
required

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.

url
string<uri>
required

The HTTPS URL events are sent to.

events
(enum<string> | string)[]
required

The event types sent to this endpoint. ["*"] sends every type, including types added later.

Available options:
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
status
enum<string>
required

enabled, or disabled after every delivery failed for 5 days. Re-enable a disabled endpoint by updating it with status: enabled.

Available options:
enabled,
disabled
api_version
string
required

The version events are rendered in. Set when the endpoint is created; it cannot be changed.

created_at
string<date-time>
required

When the endpoint was created.

description
string | null

Your label for the endpoint. null when you set none.

disabled_reason
string | null

Why Reflections disabled the endpoint. null while enabled.

connected
boolean

Whether the endpoint also receives events about connected licensees' objects. Those events carry the licensee's ID in account.

secret
string | null

whsec_…. Returned only when the endpoint is created or its secret rotated.

metadata
object

Keys and values of your own.