Documentação

ReferênciaEventos de webhook

Ping

Enviado ao criar a assinatura e ao trocar a sua URL, e pelo teste (POST /webhooks/{id}/test). Não pode ser assinado.

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.

event*string

Sempre webhook.ping

Value in

  • "broker.created"
  • "broker.updated"
  • "broker.deleted"
  • "property.created"
  • "property.updated"
  • "property.deleted"
  • "listing.created"
  • "listing.updated"
  • "listing.deleted"
  • "party.created"
  • "party.updated"
  • "party.deleted"
  • "party.merged"
  • "party.unmerged"
  • "lead.created"
  • "lead.updated"
  • "lead.stage_changed"
  • "lead.assigned"
  • "lead.qualified"
  • "lead.discarded"
  • "deal.created"
  • "deal.updated"
  • "deal.stage_changed"
  • "deal.won"
  • "deal.lost"
  • "whatsapp_message.received"
  • "whatsapp_message.sent"
  • "whatsapp_message.status_changed"
  • "task.created"
  • "task.updated"
  • "task.completed"
  • "task.cancelled"
  • "visit.scheduled"
  • "visit.updated"
  • "visit.cancelled"
  • "proposal.created"
  • "proposal.updated"
  • "proposal.deleted"
  • "contract.created"
  • "contract.updated"
  • "contract.deleted"
  • "document.created"
  • "document.updated"
  • "document.deleted"
  • "webhook.ping"
timestamp*string

Quando o ping foi enviado, em segundos (RFC 3339)

Formatdate-time
webhook_id*string

A assinatura

Response Body

Example Requests

POST/webhook.ping