Criar uma fonte

POST

/v1/ingest/sources

Cria a fonte só com nome e tipo, e já devolve a URL de ingestão pronta em url. É ela que você cola no painel do provedor. Provedor, segredo e destinos vêm depois, alterando a fonte.

type é webhook, o padrão, para receber de um provedor externo, ou cron, para a própria fonte gerar uma mensagem num horário.

Autorização

• Bearer

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

name

obrigatório

null | string

type

obrigatório

null | string

Exemplo

{
  "name": "Mercado Pago",
  "type": "webhook"
}

Respostas

201

Criado.

Tipo de mídiaapplication/json

object

id

obrigatório

string

name

obrigatório

string

type

obrigatório

string

status

obrigatório

string

url

obrigatório

string

provider

obrigatório

string

hasSecret

obrigatório

boolean

providerConfig

obrigatório

null | object

cronExpression

obrigatório

null | string

cronTimezone

obrigatório

null | string

cronPayload

obrigatório

null | string

nextRunAt

obrigatório

null | string formato: date-time

lastRunAt

obrigatório

null | string formato: date-time

lastMessageAt

obrigatório

null | string formato: date-time

silenceAlertMinutes

obrigatório

null | integer | string formato: int32

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

alertEmails

obrigatório

null | string

destinations

obrigatório

integer | string formato: int32

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

createdAt

obrigatório

string formato: date-time

Exemplo^gerado

{
  "id": "example",
  "name": "example",
  "type": "example",
  "status": "example",
  "url": "example",
  "provider": "example",
  "hasSecret": true,
  "providerConfig": "example",
  "cronExpression": "example",
  "cronTimezone": "example",
  "cronPayload": "example",
  "nextRunAt": "2026-04-15T12:00:00Z",
  "lastRunAt": "2026-04-15T12:00:00Z",
  "lastMessageAt": "2026-04-15T12:00:00Z",
  "silenceAlertMinutes": 1,
  "alertEmails": "example",
  "destinations": 1,
  "createdAt": "2026-04-15T12:00:00Z"
}

401

Chave de API ausente, inválida ou revogada.

402

O limite de fontes de recebimento do plano foi atingido.

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

Nome ausente, com mais de 200 caracteres ou já usado no ambiente, ou type inválido.

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.