v1

latestOpenAPI 3.1.02026-08-041120270.3 KB

/v1/subscription

Ednpoint responsável por cadastrar uma nova subscription

post/v1/subscription

namestring required

Nome

endpointUrlstring required

Url do enpoint à ser acionado

bodystring json required

Parâmetros da requisição à ser realizada, levando em conta os campos disponíveis de acordo com o tipo de evento

headersstring json

Cabeçalhos necessários para execução do endpoint associado

retriesinteger required

Número de retentativas em caso de falha

timeoutinteger required

Tempo em segundos para aguardar resposta do endpoint acionado

isActivestring

Indica se a subscription está ativa ou não

webHookEventTypestring required

Tipo do evento à ser associado. Lista de disponíveis pode ser consultada em "GET v1/webhookevent

201

codeinteger

successboolean

{"stackTrail":"paths:/v1/subscription:post:responses:201:content:application/json:schema:properties:data","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/subscription:post:responses:201:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

{
  "code": 201,
  "success": true
}