v1

latestOpenAPI 3.1.02026-07-249043961.2 KB

Webhooks

Informações do Webhook

Consulta informações específicas de um Webhook.

get/v1/webhooks/{id}

idstring required

ID do webhook

User-Agentstring

Informar um e-mail válido para contatos.

Webhook encontrado

idinteger

ID do webhook

namestring nullable

Nome de identificação do webhook

urlstring required

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

content_typestring nullable

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

eventsstring[] required

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

activeboolean nullable

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

ssl_verification_enabledboolean nullable

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

subaccountsboolean

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

bank_billet_account_idinteger nullable

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

auth_kind'none' | 'basic_auth' | 'bearer' | 'api_key' nullable

Tipo de autenticação configurado. Retornado nas respostas. Para configurar, envie o objeto auth no body.

created_atstring date-time nullable

Data e hora de criação do registro

updated_atstring date-time nullable

Data e hora da última atualização do registro