Atualizar Webhook

put

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

Atualiza informações específicas de um webhook.

Path Params

string

required

ID do webhook

Body Params

Informações a serem atualizadas no webhook

name

string | null

Nome de identificação do webhook

url

string

required

length ≤ 255

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

content_type

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*

active

boolean | null

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

ssl_verification_enabled

boolean | null

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

subaccounts

boolean

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

bank_billet_account_id

integer | null

deprecated

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

Headers

User-Agent

string

Informar um e-mail válido para contatos.

Responses

204

Webhook atualizado

Language

Credentials

Bearer

URL

Response

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

application/json

401Falha de autenticação. Token inválido

403Falha de permissão. Você não tem o Scope obrigatório para essa chamada.

404Webhook não encontrado