Pular para o conteúdo principal
PATCH
/
v1
/
webhooks
/
{webhookId}
curl --request PATCH \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "enabled": false
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Operations webhook",
  "endpointUrl": "https://hooks.example.com/transfer-events",
  "enabled": false,
  "eventTypes": [
    "transfer.completed"
  ],
  "createdAt": "2026-02-01T15:30:00Z",
  "updatedAt": "2026-02-01T16:00: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.

Cabeçalhos

​
X-Idempotency
string
obrigatório

Chave de idempotência obrigatória para tentativas seguras. Use um UUID v4 ou identificador de negócio único. Se a mesma chave for enviada novamente e a solicitação original já tiver sido processada, a resposta em cache será retornada.

Consulte Tentativas e idempotência para detalhes.

Maximum string length: 255

Parâmetros de caminho

​
webhookId
string<uuid>
obrigatório

O identificador único do registro de webhook a ser atualizado.

Corpo

application/json

Apenas os campos presentes na requisição são atualizados. Enviar eventTypes como null limpa o filtro para que o registro receba todos os tipos de evento.

​
name
string

Um nome legível por humanos para o registro.

Exemplo:

"Operations webhook"

​
endpointUrl
string<uri>

O endpoint que recebe as entregas de eventos. Deve ser uma URL HTTPS.

Pattern: ^https://
Exemplo:

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

​
enabled
boolean

Se o registro está ativo.

Exemplo:

true

​
eventTypes
string[] | null

Os tipos de evento que este endpoint assina. Envie null para limpar o filtro e receber todos os tipos de evento.

Maximum array length: 64
Exemplo:
["transfer.completed"]

Resposta

Indica que o registro de webhook foi atualizado.

Chamadas repetidas com a mesma chave X-Idempotency reproduzem a resposta em cache.

Consulte Tentativas e idempotência para mais detalhes.

​
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"]