KOkobana
Webhooks

Criar Webhook

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

post/v1/webhooks

Request

Headers

User-Agentstring

Informar um e-mail válido para contatos.

X-Idempotency-Keystring

Chave de idempotência para evitar replay de processamento.

Request body

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

Response

Webhook criado com Basic Auth

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

Changes

No recorded changes to this operation across all 1 revision of this API.