Rotaciona o segredo de assinatura do endpoint

POST/v1/webhooks/{id}/rotate-secret

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros do caminho

idstringobrigatório
Identificador público (wbe_/wbh_…)

Respostas

200Sucesso

idstringobrigatório
Identificador público (wbe_/wbh_…)
namestringobrigatório
Nome do endpoint.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
eventsstring[]obrigatóriopode ser nulo
Os tipos de evento entregues; null com forceActive.
secretstringobrigatório
O segredo de assinatura do endpoint — mostrado UMA vez, aqui. Use-o para verificar a assinatura de cada entrega.
enabledbooleanobrigatório
Se o endpoint recebe entregas.
endpointstringobrigatório
A URL que recebe os eventos.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
metadataobjectobrigatóriopode ser nulo
Os seus metadados chave-valor; null quando não há.
shotsQtyintegerobrigatório
Total de entregas tentadas.
createdAtstringobrigatório
Quando o recurso foi criado (ISO 8601, UTC).
updatedAtstringobrigatório
Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
disabledAtstringobrigatóriopode ser nulo
Quando foi desativado; null enquanto ativo.
forceActivebooleanobrigatório
Se todos os tipos de evento são entregues.
disabledReasonstringobrigatóriopode ser nulo
Quem desativou: seller (você), circuitBreaker (a proteção automática, depois de falhas seguidas) ou staff; null enquanto ativo.
Valores:sellercircuitBreakerstaff
failedShotsQtyintegerobrigatório
Entregas que falharam.
lastDeliveryAtstringobrigatóriopode ser nulo
Quando a última entrega foi feita; null quando não houve.
disabledCanceledDispatchesintegerobrigatóriopode ser nulo
Quantas entregas pendentes a desativação cancelou; null quando você mesmo desativou.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorConsulta um evento de webhook + as entregas dele PróximaReenvia um evento de webhook