Skip to main content
POST
Configurar cliente

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Body

application/json
webhook_endpoint
string<url>
required

URL do webhook para receber notificações

Example:

"https://api.meusite.com/webhook/nexus"

events
string[]
required

Lista de eventos para receber notificações via webhook. Eventos disponíveis: user_updated, user_onboarded, bank_account_updated, bank_account_deleted, product_updated, product_deleted, product_affiliate_deleted, product_coproducer_deleted, offer_updated, offer_deleted, refund_requested, refund_updated, cashout_requested, cashout_updated, anticipation_requested, anticipation_updated, fee_tier_updated, order_created, order_item_status_changed, transaction_created, transaction_updated, subscription_cancelled, subscription_resumed, subscription_extended, subscription_overdue, subscription_ended, charge_reminder, trial_started, trial_ended

Example:
files_domain
string<url> | null

Domínio para arquivos (e-books, etc.). Usado para validar URLs de arquivos enviados pelo cliente.

Example:

"https://files.minha-plataforma.com"

active
boolean | null

Status ativo/inativo das notificações

Example:

true

logo
string<url> | null

URL do logotipo do cliente

Example:

"https://cdn.minha-plataforma.com/logo.png"

Response

Configurações salvas com sucesso

webhook_endpoint
string<url>
required

URL do webhook configurada

Example:

"https://api.meusite.com/webhook/nexus"

events
string[]
required

Lista de eventos configurados

Example:
files_domain
string<url> | null

Domínio para arquivos configurado

Example:

"https://files.minha-plataforma.com"

active
boolean | null

Status ativo/inativo das notificações

logo
string<url> | null

URL do logotipo do cliente

Example:

"https://cdn.minha-plataforma.com/logo.png"