Documentação

ReferênciaEventos de webhook

Negócio mudou de etapa

O corpo é o registro inteiro, sem os campos de link de compartilhamento, de assinatura e de arquivo; uma lista ou um mapa vazio pode vir null. Chegar a uma etapa de ganho ou de perda envia também deal.won ou deal.lost.

Header Parameters

X-Webhook-Event*string

O evento entregue.

X-Webhook-Signature*string

sha256= seguido do HMAC-SHA256, em hexadecimal, do corpo exatamente como recebido, com o segredo da assinatura (secret) como chave. Compare em tempo constante.

X-Webhook-Delivery?string

A entrega, a mesma em todas as tentativas: use-a para descartar repetições. Também é o id da entrega em GET /webhooks/{id}/deliveries. Ausente no teste (POST /webhooks/{id}/test).

User-Agent?string

Nobur-Webhooks/1.0. Ausente no teste (POST /webhooks/{id}/test).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contact_name?string

Nome do contato, ou o telefone quando não há nome. Ausente se a credencial não pode ver o contato.

contact_phone?string
created_at*string

Data de criação

Formatdate-time
created_by*string

Identificador de quem criou

custom_fields*|null
id*string
lost_at?string
Formatdate-time
lost_reason?string
organization_id*string

Identificador da organização

owner_user_id?string
owner_user_name?string

Nome do responsável

party_id*string
property_ids?array<string>|null
proposal_ids?array<string>|null
proposals?array<>|

Propostas ligadas que a credencial pode ver

purpose*string

Value in

  • "compra"
  • "locacao"
search_profile?
source_lead_id?string

Primeiro lead do negócio, para atribuição

stage_id*string
status*string

Categoria da etapa atual

Value in

  • "aberto"
  • "ganho"
  • "perdido"
tenant_id*string

Identificador do tenant

updated_at*string

Data da última atualização

Formatdate-time
updated_by*string

Identificador de quem atualizou

value_cents?integer
Formatint64
visibility*string

Nível de visibilidade do recurso

Value in

  • "restricted"
  • "organization"
won_at?string
Formatdate-time

Response Body

Example Requests

POST/deal.stage_changed