Navegar na documentação

Encaminhar avisos de conta, cobrança e API a um responsável claro

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

REST API v1

Sua plataforma

Visão geral

Ler changelog

Acompanhar atualizações da plataforma

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

Falar com o suporte

Encaminhar dúvidas de suporte

Use o contato para cobrança, 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 equipes 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 mudanças para desenvolvedores entram no changelog público.

Modelo de avisos

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

Mudanças 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 cobrança

Encaminhar upgrades bem-sucedidos, pagamentos falhos, renovações e mudanças do portal.

Compatibilidade da API

Usar entradas do changelog para endpoints novos, campos de resposta e mudanças de limite documentadas.

Canais de aviso

O que cada mensagem deve incluir

Poucas palavras

Saldo e planoInclua palavras restantes, plano e um link para cobrança 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 cobrançaLink para a cobrança do espaço de trabalho e o portal após o login.

Mudança de API

Link da docsAponte para a seçã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 ao seu fluxo de trabalho.Continuar lendo