Pular para o conteúdo principal
GET
/
v1
/
webhooks
/
{webhookId}
Obter um Registro de Webhook
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Operations webhook",
  "endpointUrl": "https://hooks.example.com/transfer-events",
  "enabled": true,
  "eventTypes": [
    "transfer.completed"
  ],
  "createdAt": "2026-02-01T15:30:00Z",
  "updatedAt": "2026-02-01T15:30:00Z"
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticação por token JWT Bearer. O tenantId é derivado do token bearer ou do contexto de requisição autenticado e não é fornecido por meio do X-Organization-Id.

Parâmetros de caminho

​
webhookId
string<uuid>
obrigatório

O identificador único do registro de webhook.

Resposta

Indica que o registro de webhook foi encontrado e seus detalhes são retornados.

​
id
string<uuid>
obrigatório

O identificador único do registro de webhook.

Exemplo:

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

​
name
string
obrigatório

O nome legível por humanos do registro.

Exemplo:

"Operations webhook"

​
endpointUrl
string<uri>
obrigatório

O endpoint HTTPS que recebe as entregas de eventos.

Exemplo:

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

​
enabled
boolean
obrigatório

Se o registro está ativo.

Exemplo:

true

​
createdAt
string<date-time>
obrigatório

O timestamp de quando o registro foi criado.

Exemplo:

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

​
updatedAt
string<date-time>
obrigatório

O timestamp da última atualização.

Exemplo:

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

​
eventTypes
string[]

Os tipos de evento que este endpoint assina. Ausente quando o registro recebe todos os tipos de evento.

Exemplo:
["transfer.completed"]