Skip to main content
WEBHOOK
Para utilizar nossas APIs e Webhooks de linhas virtuais, é necessário aderir ao nosso manual de branding
Emitido quando o saldo de dados de uma linha da sua empresa cai para 20% ou para 0% dos dados do plano. O campo threshold diz qual nível foi atingido:
  • 20: a linha está perto de ficar sem dados;
  • 0: os dados do plano acabaram.
O payload traz o phoneAccountId e o threshold. Para ver o saldo da linha, consulte Consultar saldo; ele mostra a mesma leitura que disparou o evento.
  • Um evento por leitura de saldo. Se o saldo cair de uma vez abaixo dos dois níveis, por exemplo de 30% para 0%, você recebe só o mais grave: 0.
  • Os níveis se renovam. Quando o saldo sobe, por uma recarga ou pela virada do ciclo, cada nível volta a disparar na próxima vez que for atingido.
O evento reflete o saldo da linha na última leitura feita junto à operadora, que pode levar algum tempo para acompanhar o consumo real.
Os eventos podem chegar fora de ordem ou mais de uma vez. Trate o mesmo phoneAccountId e threshold recebidos em sequência como um único aviso.

Headers

svix-id
string
required

Identificador único da mensagem. Se a mesma mensagem for reenviada, o valor se repete — use-o para descartar entregas duplicadas.

Example:

"msg_2KWPBgLlAfxdpx2AI54pPJ85f4W"

svix-timestamp
string
required

Momento do envio, em segundos desde a época Unix. Faz parte da assinatura; rejeite mensagens com horário muito distante do atual.

Example:

"1674087231"

svix-signature
string
required

Assinatura da mensagem, usada para confirmar que ela foi enviada pela Salvy. Veja a página de verificação de webhooks.

Example:

"v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4="

Body

application/json
type
string
required

Nome do evento

Allowed value: "phone-account.data-balance-low"
Example:

"phone-account.data-balance-low"

timestamp
string
required

Data e hora da emissão do evento

Example:

"2025-09-03T00:00:00Z"

data
object
required

Conteúdo do evento

Response

200 - application/json