Pular para o conteúdo principal

kobana inbox system-events

Comandos de kobana inbox system-events. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
system-events listGET /v1/system-eventsListar system events
system-events getGET /v1/system-events/{id}Obter system event

system-events list​

Listar system events

kobana inbox system-events list [OPÇÕES]

GET /v1/system-events

Paginação keyset. Filtros são query params tipados (campo=valor, campo[op]=valor); filtros desconhecidos, campos não ordenáveis e valores malformados são rejeitados com 400 VALIDATION_ERROR.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
limitintegernão
cursorstringnãoCursor opaco retornado em meta.next_cursor da página anterior.
sort_bystringnãoCampo de ordenação. Permitidos: created_at, slug. Sem ele, a ordem é created_at decrescente. Valores: created_at, slug.
sort_orderstringnãoasc (padrão) ou desc. Exige sort_by. Valores: asc, desc.
slugstringnãoIgualdade. Também slug[in]=a,b.
inbox_idstringnãoIgualdade. Também inbox_id[in]=a,b.
email_idstringnãoIgualdade. Também email_id[in]=a,b.
created_atstringnãoIgualdade. Também created_at[in]=a,b e created_at[gt|gte|lt|lte].
created_at[gte]stringnão
created_at[lte]stringnão

Cabeçalhos

NomeTipoObrigatórioDescrição
x-origin-shared-secretstringnãoSegredo compartilhado entre o CloudFront e a origem. Obrigatório em produção; ignorado em desenvolvimento a menos que CF_ORIGIN_SHARED_SECRET esteja definido.

Respostas

HTTPDescrição
200Página de resultados.
400O corpo falhou na validação Zod. error.details carrega formErrors/fieldErrors.
404Recurso não encontrado ou filtrado por soft-delete.

system-events get​

Obter system event

kobana inbox system-events get [ID] [OPÇÕES]

GET /v1/system-events/{id}

Argumentos do caminho: id

Cabeçalhos

NomeTipoObrigatórioDescrição
x-origin-shared-secretstringnãoSegredo compartilhado entre o CloudFront e a origem. Obrigatório em produção; ignorado em desenvolvimento a menos que CF_ORIGIN_SHARED_SECRET esteja definido.

Respostas

HTTPDescrição
200Sucesso.
404Recurso não encontrado ou filtrado por soft-delete.