Cria um assinante de webhook e devolve o segredo uma vez (só ADMIN)

Cabeçalhos (header)

• Authorizationtextoobrigatório

  Sessão do administrador no portal: Bearer seguido do token. Rota de administrador; o TMS não a chama com a chave de API.

• Content-Typetextoobrigatório

  Sempre application/json.

Corpo (body) · application/json

• nometextoobrigatório

  de 1 a 120 caracteres

• ambientetexto (lista fixa)opcional

  Desde a 0.21.0. Ambiente do assinante; não muda depois de criado. Em PRODUCAO a url precisa ser https. http e endereço local só valem em TESTE. Na atualização, omitido mantém o atual.

  Valores: TESTE, PRODUCAO; padrão: "PRODUCAO"

• urltextoobrigatório

  Endereço público HTTPS. Endereço interno é recusado.

• tiposlista de texto (lista fixa)obrigatório

  Valores: parada.chegada, parada.saida, baixa.registrada, ocorrencia.registrada, comprovante.emitido, evento_cte.estado_alterado, posicao.lote, veiculo.km_registrado; ao menos 1 item(ns)

• papeltexto (lista fixa)obrigatório

  Valores: TMS, TERCEIRO

• escopoCnpjslista de textoopcional

  Raízes de 8 caracteres. Obrigatório quando papel é TERCEIRO. PDF e canhoto só saem se o terceiro for o tomador.

• cadenciaPosicaoMintexto (lista fixa)opcional

  Só para papel TMS e tipo posicao.lote. Embarcador e destinatário não recebem posição.

  Valores: 5, 10, 15

• contatoEmailtextoobrigatório

  Dado pessoal. Não registrar em log.

  até 320 caracteres

Exemplos de corpo

{
  "nome": "texto",
  "ambiente": "PRODUCAO",
  "url": "https://exemplo.com.br/webhook-veltra",
  "tipos": [
    "parada.chegada"
  ],
  "papel": "TMS",
  "escopoCnpjs": [
    "texto"
  ],
  "cadenciaPosicaoMin": 5,
  "contatoEmail": "texto"
}