Adicionar um destino

POST

/v1/ingest/sources/{id}/destinations

Para onde a fonte repassa o que recebe: uma URL sua. A mensagem vai com o corpo e o Content-Type originais do provedor, assinada com o secret do destino nos mesmos headers Webhook-* do envio: o seu código verifica do mesmo jeito.

O secret aparece só nesta resposta. A URL passa pela mesma validação dos endpoints, os headers fixos seguem as mesmas regras, e cada fonte aceita até 10 destinos.

Autorização

• Bearer

Parâmetros

Parâmetros de caminho

id

obrigatório

string

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

url

obrigatório

null | string

description

obrigatório

null | string

headers

obrigatório

null | object

Exemplo

{
  "url": "https://api.padariadoze.com.br/pagamentos/webhook",
  "description": "Backend de pagamentos"
}

Respostas

201

Criado.

Tipo de mídiaapplication/json

object

id

obrigatório

string

url

obrigatório

string

secret

obrigatório

string

Exemplo^gerado

{
  "id": "example",
  "url": "example",
  "secret": "example"
}

401

Chave de API ausente, inválida ou revogada.

404

A fonte não existe, ou não é deste ambiente.

422

URL ausente ou recusada pela validação, header inválido, ou a fonte já tem 10 destinos.

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.