Referência da API
SiteCentral de AjudaAPI Status

Criar Webhook

post
https://{apiHost}/v1/webhooks

Cria um webhook para receber notificações de eventos do sistema via HTTP.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Informações a serem salvas no webhook

string | null

Nome de identificação do webhook

string
required
length ≤ 255

Endereço onde as requisições serão realizadas

string | null

Content-type da requisição que será realizada. Valores válidos application/json (valor padrão) ou application/x-www-form-urlencoded.

events
array of strings
required

Eventos que devem gerar notificações para o webhook. Escolha um ou mais eventos.

events*
boolean | null

Define se o webhook estará ativo, recebendo notificações. O valor padrão é true.

boolean | null

Define se a verificação SSL está habilitada no webhook.

boolean

Define se o webhook estará ativo para os eventos das subcontas.

integer | null
deprecated

ID da Carteira de Cobrança. Se informado, o webhook apenas receberá notificações de eventos relacionados à carteira indicada.

auth
object | null

Configuração de autenticação do endpoint receptor. Apenas para criação/atualização — não retornado nas respostas.

Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Updated 7 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago