Skip to main content
Documento específico de integração BYOK com Rewrite Today para SMS.

​
Objetivo

Quando o workspace tiver integração ativa da Rewrite, os envios de SMS da Notifique tentam primeiro a Rewrite. Em caso de falha, a Notifique segue para fallback interno da plataforma.

​
Endpoint externo utilizado

​
Autenticação

  • Tipo: BEARER via API key da Rewrite
  • Header: Authorization: Bearer rw_...

​
Mapeamento de payload (Notifique -> Rewrite)

  • to (Notifique): telefone normalizado no fluxo SMS
    • convertido para E.164 com + (ex.: +5511999999999)
  • message (Notifique):
    • mapeado para content na Rewrite
  • metadata (Notifique), quando houver:
    • mapeado para tags na Rewrite ([{ name, value }])
    • inclui tags técnicas como workspaceId e refer quando presentes

​
Exemplo enviado para Rewrite

{
  "to": "+5511999999999",
  "content": "Your OTP code is 941205",
  "tags": [
    { "name": "workspaceId", "value": "ckx..." },
    { "name": "refer", "value": "otp-login-2026-03-31" },
    { "name": "flow", "value": "login" }
  ]
}

​
Idempotência

Quando houver refer no fluxo interno, a Notifique envia:
  • Idempotency-Key: <refer>
Isso reduz risco de duplicação em retries externos.

​
Agendamento

  • A Notifique não usa scheduledAt da Rewrite.
  • O agendamento é sempre realizado pela fila/scheduler da Notifique.

​
Failover

Se a Rewrite retornar erro HTTP, timeout, ou falha de transporte:
  1. tentativa externa marcada como falha;
  2. próximo provedor externo (se existir, conforme ordem);
  3. fallback para cadeia interna da Notifique.

​
Observabilidade

Cada envio registra:
  • providerType: EXTERNAL ou INTERNAL
  • providerName: Rewrite Today (quando externo)
  • providerResponse: resposta externa sanitizada
  • providerExternalMessageId: id aceito no provedor externo, quando disponível

​
Requisitos de configuração no workspace

  1. Canal: SMS
  2. Provedor: Rewrite Today
  3. Credencial: API key da Rewrite
Após salvar, a credencial não é exibida novamente em plaintext.