Cadastrar um tipo de evento

POST

/v1/event-types

Só tipos cadastrados podem ser publicados: é o que impede um erro de digitação de virar um evento que ninguém recebe.

O nome segue dominio.acao, em minúsculas, com dígitos e . _ - como separadores, por exemplo pedido.pago ou nota_fiscal.emitida. Ele é o identificador do tipo: é o que vai no campo type ao publicar e na lista events de um endpoint.

Autorização

• Bearer

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

name

obrigatório

null | string

description

obrigatório

null | string

Exemplo

{
  "name": "pedido.pago",
  "description": "Pagamento de um pedido confirmado."
}

Respostas

201

Criado.

Tipo de mídiaapplication/json

object

name

obrigatório

string

description

obrigatório

null | string

createdAt

obrigatório

string formato: date-time

Exemplo

{
  "name": "pedido.pago",
  "description": "Pagamento de um pedido confirmado.",
  "createdAt": "2026-09-10T12:00:00Z"
}

401

Chave de API ausente, inválida ou revogada.

409

O tipo já existe no ambiente.

Tipo de mídiaapplication/problem+json

object

type

null | string

title

null | string

status

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

422

name ausente, fora do formato, ou com mais de 200 caracteres.

Tipo de mídiaapplication/problem+json

object

type

null | string

title

null | string

status

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.