Excluir um endpoint

Este endpoint remove um webhook endpoint configurado. Ao excluir, você interrompe o envio de notificações para a URL especificada.

Visão Geral

Este endpoint remove um webhook endpoint configurado. Ao excluir, você interrompe o envio de notificações para a URL especificada.

Precauções

A exclusão é permanente.
Certifique-se de que sistemas dependentes estejam preparados para deixar de receber notificações.
Para apenas pausar (sem excluir), use PUT /v1/webhooks/{webhookId} com enabled: false.

Descrição

Útil para interromper completamente o recebimento de notificações em um endpoint, como em mudança de infraestrutura, desativação de integrações ou problemas de segurança.

Requisição

DELETE /v1/webhooks/{webhookId}

Cabeçalho: SelectKey: sk_live_... (ou sk_test_...). Escopo necessário: webhooks:delete.

Parâmetros de Caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
`webhookId`	string	Sim	ID do webhook (`wbe_`; legados `wbh_`)	`wbe_01hqzvabc`

Exemplo de Requisição

DELETE /v1/webhooks/wbe_01hqzvabc

Resposta

Sucesso (200 OK)

{
  "id": "wbe_01hqzvabc",
  "resource": "webhook",
  "deleted": true,
  "merchant": {
    "name": "Seller Name",
    "merchantId": "bus_1234567890",
    "isSubAccount": false
  },
  "_links": {
    "self": {
      "href": "https://api.selectwin.io/v1/webhooks/wbe_01hqzvabc",
      "method": "GET",
      "description": "Read a webhook."
    },
    "list": {
      "href": "https://api.selectwin.io/v1/webhooks",
      "method": "GET",
      "description": "List all webhooks."
    }
  }
}

Atributos da Resposta

Atributo	Tipo	Descrição
`id`	string	`wbe_*` excluído
`resource`	string	`"webhook"`
`deleted`	boolean	`true`
`merchant`	object	Bloco do lojista
`_links`	object	HATEOAS

Erros

Webhook não encontrado (404 Not Found)

{
  "error": {
    "status": "Not Found",
    "statusCode": 404,
    "category": "resource",
    "message": "Webhook endpoint not found.",
    "suggestedActions": [
      "Verifique se o ID do webhook está correto",
      "Certifique-se de que o webhook existe no sistema"
    ],
    "docUrl": "https://docs.api.selectwin.io/errors/resource",
    "supportUrls": [
      "https://suporte.selectwin.io/ajuda"
    ]
  }
}

ID de webhook inválido (400 Bad Request)

{
  "error": {
    "status": "Bad Request",
    "statusCode": 400,
    "category": "validation",
    "message": "Validation errors occurred.",
    "params": [
      {
        "id": "O formato do ID do webhook é inválido. Formato esperado: wbe_XXXXXXXXX"
      }
    ],
    "suggestedActions": [
      "Verifique o formato do ID do webhook"
    ],
    "docUrl": "https://docs.api.selectwin.io/errors/validation",
    "supportUrls": [
      "https://suporte.selectwin.io/ajuda"
    ]
  }
}

Erro de autenticação (401 Unauthorized)

{
  "error": {
    "status": "Unauthorized",
    "statusCode": 401,
    "category": "authentication",
    "message": "Authentication failed.",
    "details": "Invalid or missing API key.",
    "suggestedActions": [
      "Verifique se a chave de API foi fornecida corretamente no cabeçalho SelectKey",
      "Certifique-se de que sua chave de API está ativa e tem as permissões necessárias"
    ],
    "docUrl": "https://docs.api.selectwin.io/errors/authentication",
    "supportUrls": [
      "https://suporte.selectwin.io/ajuda"
    ]
  }
}

Acesso negado (403 Forbidden)

{
  "error": {
    "status": "Forbidden",
    "statusCode": 403,
    "category": "authorization",
    "message": "Access denied to the requested resource.",
    "details": "You do not have permission to delete this webhook.",
    "suggestedActions": [
      "Verifique se você tem o escopo webhooks:delete",
      "Certifique-se de que o webhook pertence à sua conta"
    ],
    "docUrl": "https://docs.api.selectwin.io/errors/authorization",
    "supportUrls": [
      "https://suporte.selectwin.io/ajuda"
    ]
  }
}

Melhores Práticas

Notifique os sistemas integrados antes de excluir um webhook.
Verifique o webhookId cuidadosamente antes de excluir.
Considere desativar temporariamente (enabled: false) em vez de excluir, se houver chance de reativá-lo.
Monitore a resposta (deleted: true) para confirmar a exclusão.

Excluir um endpoint

On this page