Skip to main content
GET
Get a Webhook Registration

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

webhookId
string<uuid>
obrigatório

The unique identifier of the webhook registration.

Resposta

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

id
string<uuid>
obrigatório

The unique identifier of the webhook registration.

Exemplo:

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

name
string
obrigatório

The human-readable name of the registration.

Exemplo:

"Operations webhook"

endpointUrl
string<uri>
obrigatório

The HTTPS endpoint that receives event deliveries.

Exemplo:

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

enabled
boolean
obrigatório

Whether the registration is active.

Exemplo:

true

createdAt
string<date-time>
obrigatório

The timestamp when the registration was created.

Exemplo:

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

updatedAt
string<date-time>
obrigatório

The timestamp of the last update.

Exemplo:

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

eventTypes
string[]

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

Exemplo: