Skip to main content
POST

Body

application/json

Envelope padrão de todos os webhooks enviados pelo Nexus. O campo payload varia conforme o evento.

event
string
required

Nome do evento disparado

Example:

"user_updated"

endpoint
string<url>
required

URL do webhook configurada pelo cliente

Example:

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

payload
object
required

Payload do evento user_onboarded. Disparado quando o onboarding do usuário é concluído. O formato varia conforme o tipo: person ou company.

metadata
object
required

Metadados de rastreamento do webhook

created_at
string<date-time>
required

Data de criação do webhook (ISO 8601)

Example:

"2026-02-25T10:00:00.000000Z"

updated_at
string<date-time>
required

Data de atualização do webhook (ISO 8601)

Example:

"2026-02-25T10:00:00.000000Z"

Response

200

Webhook recebido com sucesso