Eventos
/v1/assinaturasAssina eventos numa URL. Devolve o segredo de assinatura UMA vez
Padrões aceitos em eventos: o nome exato, recurso.* ou *. Só chegam eventos de recursos que a chave pode ler.
- Escopo:
- webhook:gerenciar
- Resposta:
- 201
Pedido
Corpo (JSON)
| Campo | Tipo | O que é |
|---|---|---|
| url* | texto até 500 caracteres | A URL, com esquema. |
| eventos* | lista de texto 1–20 itens | Os eventos abrangidos. |
| descricao | texto até 200 caracteres | Para que serve esta assinatura. Aparece na lista — com três assinaturas ativas, é o que distingue uma da outra. |
* obrigatório. Campo desconhecido é recusado, não ignorado: a API responde VALIDATION_ERROR em vez de descartar em silêncio.
Exemplo de chamada
curl -X POST https://api.miydas.com.br/v1/assinaturas \
-H "Authorization: Bearer $MIYDAS_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"url": "https://produto.exemplo.com.br/webhooks/miydas",
"eventos": [
"autorizacao.*"
],
"descricao": "Avisos de autorização"
}'Resposta 201
| data | AssinaturaCriada | O recurso. Os campos estão na tabela abaixo. |
Campos de AssinaturaCriada
| Campo | Tipo | O que é |
|---|---|---|
| id | texto | Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato. |
| url | texto | A URL, com esquema. |
| eventos | lista de texto | Nomes exatos, recurso.* ou * |
| descricao | texto | Para que serve esta assinatura. É o que distingue uma da outra na lista. |
| ativa | booleano | A assinatura está recebendo eventos. |
| criadaEm | texto | Quando o registro nasceu no Miydas, em ISO 8601 com fuso. |
| atualizadaEm | texto | Quando o registro mudou pela última vez no Miydas, em ISO 8601 com fuso. |
| segredo | texto | Só nesta resposta. Guarde: é com ele que se confere miydas-assinatura. |
Exemplo de retorno
{
"data": {
"id": "cmf3k2x9a0003ass",
"url": "https://produto.exemplo.com.br/webhooks/miydas",
"eventos": [
"autorizacao.*"
],
"descricao": "Avisos de autorização",
"ativa": true,
"criadaEm": "2026-09-27T12:00:00.000Z",
"atualizadaEm": "2026-09-27T12:00:00.000Z",
"segredo": "whsec_exemplo"
}
}Experimente sem chave
O sandbox devolve este mesmo corpo, sem autenticação e sem tocar na base de ninguém.
curl https://api.miydas.com.br/v1/sandbox/assinaturas_criarO sandbox responde sempre em GET, mesmo para uma operação POST: ele devolve a forma da resposta, não executa nada.
A chave de teste myd_test_… é outra coisa: ela opera na homologação da operadora e serve para escrever. Para ver o formato antes de ter credencial, convênio e varredura, é este sandbox.
Erros
| Código | HTTP | Quando | O que fazer |
|---|---|---|---|
| DESTINO_NAO_PERMITIDO | 400 | A URL da assinatura não resolve para um endereço público. | Use uma URL https pública. |
Toda falha tem o mesmo formato: { "error": "CODIGO", "message": "…", "details": { … } }. error é estável e serve para lógica; message é para gente e pode mudar. Erros comuns a toda rota com chave (lista completa) não se repetem aqui.