Atualiza um endpoint de webhook

PUT/v1/webhooks/{id}

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_…)

Corpo da requisição

namestring
Nome do endpoint, para a sua referência.
eventsstring[]
Os tipos de evento a entregar (ver GET /v1/utils/types-of-webhooks). Obrigatório sem forceActive.
Valores:transaction.createdtransaction.pendingtransaction.failedtransaction.approvedtransaction.canceledtransaction.chargebacktransaction.refundedtransaction.fraud-reviewtransaction.pre-authorizedtransaction.unauthorizedtransaction.awaitingtransaction.disputecustomer.createdcustomer.updatedcustomer.deletedcustomer.address.createdcustomer.address.updatedcustomer.address.deletedcard.createdcard.updatedcard.deletedcard.expiredsubscription.createdsubscription.pendinge mais 62
enabledboolean
Se o endpoint recebe entregas.
endpointstring (uri)
A URL https:// que recebe os eventos.
metadataobject
Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.
forceActiveboolean
Entregar TODOS os tipos de evento, os de agora e os futuros, no lugar da lista events.
headerAuthorizationstring
Valor enviado no cabeçalho Authorization de cada entrega.
headerAuthorizationTypestring
Esquema do cabeçalho Authorization (ex.: Bearer).

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.
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.

400Requisição inválida (validação)

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

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 endpoint de webhook PróximaExclui um endpoint de webhook

curl -X PUT "https://api.selectwin.io/v1/webhooks/{id}" \ -H "SelectKey: $SELECTWIN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Ltda", "events": [ "transaction.created" ], "enabled": true, "endpoint": "https://example.com", "metadata": {}, "forceActive": true, "headerAuthorization": "string", "headerAuthorizationType": "string" }'

{ "id": "wbe_0a1b2c3d4e5f60718293", "name": "Acme Ltda", "_links": {}, "events": [ "string" ], "enabled": true, "endpoint": "string", "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true }, "metadata": {}, "shotsQty": 0, "createdAt": "string", "updatedAt": "string", "disabledAt": "string", "forceActive": true, "disabledReason": "seller", "failedShotsQty": 0, "lastDeliveryAt": "string", "disabledCanceledDispatches": 0 }