Publicar um evento

POST

/v1/events

Grava o Evento e cria uma Entrega para cada endpoint do Consumer inscrito no tipo, mais os endpoints sem inscrição nenhuma, que recebem todos os tipos. A resposta sai antes da entrega: 202 quer dizer aceito e gravado, não entregue.

deliveries é quantas Entregas foram criadas. Zero quer dizer que ninguém está inscrito: o evento fica registrado e não vai a lugar nenhum.

Use Idempotency-Key. Se a chamada falhar por timeout, repeti-la com a mesma chave devolve o Evento original, com 200 e Idempotency-Replayed: true, em vez de publicar de novo. A chave vale para sempre dentro do ambiente: use algo derivado do fato (pedido-1234-pago), e não um valor aleatório novo a cada tentativa.

Autorização

• Bearer

Parâmetros

Parâmetros de header

Idempotency-Key

string

Até 200 caracteres. Repetir a mesma chave devolve o Evento original em vez de publicar de novo. Tem precedência sobre o campo idempotencyKey do corpo.

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

consumer

obrigatório

null | string

type

obrigatório

null | string

data

obrigatório

idempotencyKey

obrigatório

null | string

Exemplo

{
  "consumer": "cliente-42",
  "type": "pedido.pago",
  "data": {
    "pedidoId": 1234,
    "valorCentavos": 4990
  }
}

Respostas

200

A Idempotency-Key já tinha sido usada: este é o Evento original, e nada foi publicado de novo.

Tipo de mídiaapplication/json

object

id

obrigatório

string

status

obrigatório

string

deliveries

obrigatório

integer | string formato: int32

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

Exemplo^gerado

{
  "id": "example",
  "status": "example",
  "deliveries": 1
}

Headers

Idempotency-Replayed

string

Sempre true: a resposta é a de uma publicação anterior.

202

Evento aceito e gravado. As Entregas saem em seguida.

Tipo de mídiaapplication/json

object

id

obrigatório

string

status

obrigatório

string

deliveries

obrigatório

integer | string formato: int32

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

Exemplo

{
  "id": "evt_01JB8XZQ4T9M2NKPWV3RYCF7HD",
  "status": "queued",
  "deliveries": 2
}

401

Chave de API ausente, inválida ou revogada.

402

A quota mensal de entregas do plano Free acabou.

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"
}

413

data passa de 256 KB.

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

consumer ou type ausente, Consumer ou tipo de evento não cadastrado, ou Idempotency-Key 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.