/v1/subscription

post https://totvssign.staging.totvs.app/webhooks/v1/subscription

Endpoint responsável por criar uma Subscription (WebHook).

Body Params

name

string

Defaults to Nome da Subscription

Parâmetro obrigatório, representa o nome da subscrição com no máximo 50 caracteres.

endpointUrl

string

Defaults to minhaApi/url-destino

Parâmetro obrigatório, representa a URL do serviço externo a ser notificado contendo o protocolo exemplo: https://aplicacao/url.com com no máximo 150 caracteres.

body

json

Defaults to { "identificador": "[IDDOCUMENTO]", "statusFinal": "[STATUS]" },

Parâmetro obrigatório, representa uma coleção de chave e valor contendo o corpo dos parâmetros a serem enviados na requisição ao serviço externo.

headers

json

Defaults to { "accept": "application/json, text/plain, */*" }

Parâmetro opcional, representa uma coleção de chave e valor contendo os headers a serem adicionados na requisição ao serviço externo.

retries

int32

Defaults to 1

Parâmetro obrigatório, representa o número de novas tentativas do webhook em caso de falha.

timeout

int32

Defaults to 1

Parâmetro obrigatório, representa o tempo limite e das novas tentativas em segundos.

isActive

boolean

Defaults to true

Parâmetro Opcional, Indica se a subscription (webhook) vai esta ativa

webHookEventType

string

Parâmetro obrigatório, representa o evento que vai gerar a notificação

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
17
1
curl --request POST \
2
     --url https://totvssign.staging.totvs.app/webhooks/v1/subscription \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "name": "Nome da Subscription",
8
  "endpointUrl": "minhaApi/url-destino",
9
  "body": "{ \"identificador\": \"[IDDOCUMENTO]\",     \"statusFinal\": \"[STATUS]\" },",
10
  "headers": {
11
    "accept": "application/json, text/plain, */*"
12
  },
13
  "retries": 1,
14
  "timeout": 1,
15
  "isActive": true
16
}
17
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400

500500