Skip to main content
PATCH/webhooks/update/{id}

Parâmetros de caminho

idstringrequired

Identificador do webhook.

Corpo da requisição

urlstring

Novo destino HTTPS público.

eventsstring[]

Nova seleção de eventos.

Descrição que identifica a operação.

activeboolean

Ativa ou pausa o endpoint.

Autorização

X-API-Keystringrequired

Chave VibeCash com permissão para esta operação.

Resposta

200 application/json
successbooleanrequired

Indica se a operação foi concluída pela API.

messagestringrequired

Mensagem da operação.

dataobjectrequired

Dados retornados pela operação.

Show child attributes
idstring

Resultado da operação do webhook.

requestIdstring

Identificador da requisição.

Erros

As falhas retornam o envelope com success: false. Consulte erros e códigos HTTP para interpretar validação, permissão, conflito e saldo insuficiente.

curl --request PATCH \
  --url 'https://seu-dominio/v1/webhooks/update/SEU_ID' \
  --header 'X-API-Key: tp_live_SUA_CHAVE' \
  --header 'Content-Type: application/json' \
  --data '{"active":true,"events":["payment.paid"]}'
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "id": "wh_exemplo",
    "url": "https://seu-dominio.com/webhook",
    "events": [
      "payment.paid"
    ],
    "status": "Ativo"
  },
  "requestId": "req_exemplo"
}

Pesquisar documentação

PATCH

Atualizar webhook

Altere destino, eventos ou situação de um endpoint.

Authorization
Body
Expand 4 optional fields