Skip to main content
A API cobre dois recursos: modelos e notificações. Você prepara o modelo, envia a notificação, acompanha a entrega e baixa o laudo. REST sobre HTTPS, JSON, credencial no cabeçalho. O anexo não é um recurso à parte: ele viaja dentro do próprio envio, na mesma chamada. Três características moldam qualquer integração, e vale saber delas antes de escrever código:
  • O texto vem sempre de um modelo. Você preenche as variáveis a cada envio.
  • A entrega se acompanha por consulta, chamando a notificação até o status ser terminal.
  • O ambiente é único e é produção. Cada envio entrega de verdade e desconta do saldo.
Se você chegou aqui antes de conhecer o produto, comece por O que é o Pombo.

Quickstart

Da credencial ao laudo em quatro chamadas.

Glossário

Laudo, atestação, modelo, remetente: o vocabulário antes do código.

​
Base URL

Sempre por HTTPS.

​
Autenticação

A credencial vai no cabeçalho Authorization.
Crie e revogue credenciais em Conta → API Keys. O segredo aparece uma única vez, na criação. Depois disso só resta revogar e criar outra. A credencial já diz qual é a sua organização, então você nunca precisa informá-la.
A credencial envia notificações em nome jurídico da sua organização e consome saldo. Use somente no servidor, nunca em navegador nem em app.

​
Ambiente

O ambiente é único e é produção, então vale integrar com isso em mente. Nos seus testes automatizados, use um cliente falso no lugar da API. A boa notícia é que explorar sai de graça: as leituras não custam nada, só POST /notifications desconta, e a validação roda inteira antes de qualquer cobrança. Você pode acertar o formato do envio sem gastar um único envio. O que custa é acertar o formato e errar o destinatário. Enquanto estiver ajustando, use um número e um endereço seus.

​
Objetos

Cada recurso tem um identificador ULID com prefixo próprio. As respostas não trazem campo de tipo: o prefixo é o que diz qual recurso você está olhando. Outros só aparecem nas respostas e você nunca os envia: PBD_ATCH_ (anexo), PBD_APIKEY_, PBD_CNT_, PBD_WALN_ e PBD_ATT_. O anexo em particular não é um recurso à parte: ele viaja dentro do envio, e o PBD_ATCH_ que volta serve para citá-lo num chamado de suporte, não para anexar. Datas e horas são ISO-8601 em UTC, por exemplo 2026-08-27T14:03:11.482Z.

​
Entrega e status

O envio é assíncrono. POST /notifications confirma a criação, não a entrega. Para acompanhar, consulte GET /notifications/{id} até chegar a um estado terminal. O status nunca retrocede, e READ não existe em todos os canais.
Leia notification_delivery_status. É o campo que responde se a mensagem chegou. notification_status descreve o processamento interno: uma mensagem já lida foi observada com READ no primeiro campo e PENDING no segundo.