Skip to main content
PUT
cURL

Escopo

O campo name é obrigatório em toda atualização, mesmo enviando apenas um outro campo. Omiti-lo retorna 400.
Os demais campos (url, status, events, products, fields) são opcionais — omita o que não quiser alterar.
events e products são substituídos por completo, não mesclados. Enviar events com apenas um evento remove todos os outros eventos previamente associados ao webhook.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

id
integer
required

Id do App Webhook

Body

name
string
required

Nome do app

Maximum string length: 255
url
string<uri> | null
required

URL de destino, onde os eventos serão enviados

Maximum string length: 2048
products
string[]
required

Produtos que utilizam este app

events
enum<string>[]
required

custom_id de eventos para associar ao app webhook

  • checkout_abandonment - Abandono de Checkout
  • purchase_approved - Compra aprovada
  • purchase_refused - Compra recusada
  • pix_gerado - Pix gerado
  • boleto_gerado - Boleto gerado
  • picpay_gerado - PicPay gerado
  • openfinance_nubank_gerado - Nubank gerado
  • chargeback - Chargeback
  • refund - Reembolso
  • subscription_created - Assinatura criada
  • subscription_canceled - Assinatura cancelada
  • subscription_renewed - Assinatura renovada
  • subscription_renewal_refused - Renovação de assinatura recusada
  • subscription_paused - Assinatura pausada
  • subscription_resumed - Assinatura reativada
Available options:
checkout_abandonment,
purchase_approved,
purchase_refused,
pix_gerado,
boleto_gerado,
picpay_gerado,
openfinance_nubank_gerado,
chargeback,
refund,
subscription_created,
subscription_canceled,
subscription_renewed,
subscription_renewal_refused,
subscription_paused,
subscription_resumed
status
enum<string>

Status atual do app

  • active - Ativo
  • disabled - Desativado
  • waiting_config - Aguardando Configuração
  • paused - Pausado
Available options:
active,
disabled,
waiting_config,
paused

Response

Corpo da resposta status 200

id
integer
required
read-only
name
string
required

Nome do app

Maximum string length: 255
products
object[]
required
read-only

Produtos que utilizam este app

events
object[]
required
read-only

Eventos que disparam este app

createdAt
string<date-time>
required
read-only

Data e hora de criação

updatedAt
string<date-time>
required
read-only

Data e hora da última atualização

processing_events_count
string
required
read-only
avg_latency
string
required
read-only
success_rate
string
required
read-only
status
enum<string>

Status atual do app

  • active - Ativo
  • disabled - Desativado
  • waiting_config - Aguardando Configuração
  • paused - Pausado
Available options:
active,
disabled,
waiting_config,
paused
url
string<uri> | null

URL de destino, onde os eventos serão enviados

Maximum string length: 2048
fields
any

Campos adicionais para o app