notifications

DELETE /v1/notification-connections/{connection_id}

Disconnect a destination.

Todos os endpoints de notifications

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X DELETE https://api.zinndigital.com/v1/notification-connections/{connection_id} \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Removes the destination, its routing cells, and its stored credential. The credential is removed from the vault FIRST and the result is reported rather than assumed: if the row went first and the vault delete failed, a live Slack token or webhook secret would be orphaned under a path no row names - un-enumerable, which is worse than a leak you can list.

Parâmetros

NomeTipoObrigatórioO que é
connection_id (path)stringSim
org_id (query)stringNãoThe organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it, or the call is refused `422…

Resposta

NomeTipoObrigatórioO que é
deletedbooleanNão
credential_removedbooleanNãoWhether the stored credential was actually removed. False means the vault could not be reached - the destination is gone but an operator must clean up. Reported rather than sile…