Tipos de evento

Todo evento tem um tipo, e só tipos cadastrados podem ser publicados. O catálogo existe para um erro de digitação não virar um evento que ninguém recebe: pedido.pagp é recusado com 422 na hora da publicação, em vez de ser aceito e sumir.

O nome

O nome é o identificador do tipo. É ele que vai no campo type ao publicar e na lista events de um endpoint. Não existe id separado.

• Minúsculas e dígitos, com ., _ ou - como separadores, até 200 caracteres.
• Convenção: dominio.acao, com a ação no particípio: pedido.pago, nota_fiscal.emitida, assinatura.cancelada.

Dê nome ao fato, não à reação que você espera dele. pedido.pago continua fazendo sentido quando um terceiro sistema passar a ouvir; liberar-estoque não.

Cadastrar

curl -X POST https://api.notyfacil.com.br/v1/event-types \
  -H "Authorization: Bearer $NOTYFACIL_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"pedido.pago","description":"Pagamento de um pedido confirmado."}'

A description é opcional, e vale escrevê-la: é o que explica o tipo para quem vai recebê-lo.

Um nome repetido responde 409.

Listar

curl https://api.notyfacil.com.br/v1/event-types \
  -H "Authorization: Bearer $NOTYFACIL_KEY"

Todos os tipos do ambiente, em ordem alfabética.

Mudar o formato de um tipo

Evento publicado é imutável, e quem recebe já escreveu código contra o formato do data. Mudança que acrescenta campo é segura. Mudança que remove ou muda o significado de um campo pede um tipo novo, como pedido.pago.v2, publicado lado a lado com o antigo até os receptores migrarem.

Referência: cadastrar um tipo · listar tipos