Atualizar webhook

Endpoint: PUT/PATCH /integrations/webhooks/{seller_id}/webhooks/{id}/

Autenticação: token JWT ou chave de API do vendedor. Consulte Autenticação.

Atualiza um webhook existente. São aceitos tanto PUT (substituição total) quanto PATCH (parcial). Este é também o caminho para rotacionar o segredo compartilhado: envie o novo valor em secret e o próximo despacho passará a usá-lo. Não existe um endpoint separado para rotação.

Parâmetros de caminho

string (uuid)

required

string (uuid)

required

ID do webhook.

Corpo

string

Nova URL de destino.

string

Novo segredo compartilhado. Somente gravação; a resposta não retornará este valor. Ao alterá-lo, o valor anterior é perdido — armazene o novo antes de responder ao seu cliente.

string

Nova string de inscrição em eventos. Lembre-se: a correspondência é por substring, sem diferenciar maiúsculas e minúsculas — consulte Criar webhook para a regra e os nomes canônicos de evento.

PUT exige todos os campos graváveis (url, secret, events). PATCH aceita qualquer subconjunto.

Resposta

O webhook atualizado (sem o campo secret).

{
  "id": "5a2b6f4e-9c10-4d3a-9f17-0c2a3e4b5d61",
  "url": "https://merchant.example.com/hooks/dlpay/v2",
  "events": "transaction.update.status"
}

Erros

Status	Quando
`400`	Corpo inválido ou `seller_id` não existe.
`401`	Token JWT ou chave de API ausente ou inválida.
`404`	Não existe webhook com `id` sob o `seller_id` informado.

Exemplos

curl -X PATCH https://api.dlpay.cloud/integrations/webhooks/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/webhooks/5a2b6f4e-9c10-4d3a-9f17-0c2a3e4b5d61/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://merchant.example.com/hooks/dlpay/v2"}'

import requests

response = requests.patch(
    "https://api.dlpay.cloud/integrations/webhooks/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/webhooks/5a2b6f4e-9c10-4d3a-9f17-0c2a3e4b5d61/",
    headers={"Authorization": f"Bearer {access_token}"},
    json={"secret": "whk_rotated_a8b3"},
)
webhook = response.json()

const response = await fetch(
  "https://api.dlpay.cloud/integrations/webhooks/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/webhooks/5a2b6f4e-9c10-4d3a-9f17-0c2a3e4b5d61/",
  {
    method: "PATCH",
    headers: {
      Authorization: `Bearer ${accessToken}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ events: "transaction.update.status" }),
  },
);
const webhook = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Parâmetros de caminho

Corpo

Resposta

Erros

Exemplos

​Parâmetros de caminho

​Corpo

​Resposta

​Erros

​Exemplos

Parâmetros de caminho

Corpo

Resposta

Erros

Exemplos