Skip to main content
GET
Get a Webhook Registration

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Path Parameters

webhookId
string<uuid>
required

The unique identifier of the webhook registration.

Response

Indicates that the webhook registration was found and its details are returned.

id
string<uuid>
required

The unique identifier of the webhook registration.

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

The human-readable name of the registration.

Example:

"Operations webhook"

endpointUrl
string<uri>
required

The HTTPS endpoint that receives event deliveries.

Example:

"https://hooks.example.com/transfer-events"

enabled
boolean
required

Whether the registration is active.

Example:

true

createdAt
string<date-time>
required

The timestamp when the registration was created.

Example:

"2026-02-01T15:30:00Z"

updatedAt
string<date-time>
required

The timestamp of the last update.

Example:

"2026-02-01T15:30:00Z"

eventTypes
string[]

The event types this endpoint subscribes to. Absent when the registration receives every event type.

Example: