Explorar documentação

Encaminhar avisos de conta, faturação e API a um responsável claro

As notificações são uma superfície operacional: saldo baixo, atividade de chaves, alterações de faturação, falhas de API e atualizações de produto devem chegar ao titular do espaço de trabalho.

REST API v1

A sua plataforma

Visão geral

Ler changelog

Acompanhar atualizações da plataforma

Use o changelog para endpoints, faturação, citações, documentos e comportamento da interface.

Falar com o suporte

Encaminhar dúvidas de suporte

Use o contacto para faturação, conta, volume de API e revisão de integrações.

espaço de trabalho

POSTinternal event

por conta

forma do aviso

internal event

1{
2  "type": "low_word_balance",
3  "workspace_id": "user_workspace",
4  "words_remaining": 2858,
5  "action_url": "/dashboard#workspace-billing"
6}

Notas

Saldo baixo

Avisar as equipas antes que humanizer ou detector fiquem sem palavras.

Eventos de chave

Mostrar criação, revogação e falhas de autenticação suspeitas.

Atualizações de produto

As alterações para programadores entram no changelog público.

Modelo de avisos

As notificações devem corresponder a um risco operacional real

Alterações de saldo

Avisar o titular quando as palavras restantes puderem bloquear jobs de produção.

Ciclo de vida da chave

Notificar ao criar ou revogar uma chave, ou se as falhas de autenticação aumentarem.

Eventos de faturação

Encaminhar upgrades bem-sucedidos, pagamentos falhados, renovações e alterações do portal.

Compatibilidade da API

Usar entradas do changelog para endpoints novos, campos de resposta e alterações de limite documentadas.

Canais de aviso

O que cada mensagem deve incluir

Poucas palavras

Saldo e planoInclua palavras restantes, plano e uma ligação para faturação ou preços.

Chave criada

Nome e horaInclua o rótulo e o carimbo de tempo, nunca o token em claro.

Problema de pagamento

Ação de faturaçãoLigação para a faturação do espaço de trabalho e o portal após iniciar sessão.

Alteração de API

Ligação da docsAponte para a secção exata da referência ou do changelog.

Nota de implementação. Esta página documenta o modelo de notificações. O envio de e-mail entra quando o domínio, a caixa de suporte e as preferências da conta estiverem prontos.

Em seguida, integre no seu fluxo de trabalho.Continuar a ler