Pular para o conteúdo

Tipos de evento de webhook

Contrato d166471047bd

Notificações do ciclo de vida entregues no único endpoint HTTPS configurado pelo parceiro. A Morus publica somente os tipos de evento selecionados na assinatura ativa da empresa.

Responda com qualquer status 2xx em até 10 segundos. Falhas de conexão, estouros de tempo e respostas fora da faixa 2xx podem gerar novas tentativas automáticas. A entrega ocorre pelo menos uma vez; use Webhook-Id para deduplicar. Entregas que esgotarem as tentativas automáticas ficam disponíveis para reenvio manual na área de integrações.

Uma garantia foi criada e entrou em análise.

{
"Content-Type": "application/json",
"Webhook-Id": "evt_0123456789abcdef0123456789abcdef",
"Webhook-Type": "rental_insurance.created",
"Webhook-Timestamp": "1789470000",
"Webhook-Attempt": 1,
"Webhook-Signature": "v1=24eb41b60b742d0c7be4bf8a89d250ce92f7b2f389dd0cabf321c7db0ce79f98"
}
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "rental_insurance.created",
"occurredAt": "2026-09-15T15:30:00Z",
"apiVersion": "v1",
"data": {
"id": 812,
"externalId": "RI-2026-0042",
"status": "under_review",
"tenant": {
"cpfCnpj": "52998224725",
"name": "João da Silva",
"email": "joao.silva@example.com",
"birthDate": "1990-05-12",
"phoneNumber": "+5511999999999",
"profession": "Analista de sistemas"
},
"coTenants": [
{
"cpfCnpj": "39053344705",
"name": "Maria da Silva",
"email": "maria.silva@example.com",
"birthDate": "1992-08-20",
"phoneNumber": "+5511988888888"
}
],
"property": {
"externalId": "IMOVEL-1042",
"type": "apartment",
"address": {
"zipCode": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "Apto 81",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
},
"rentalAmount": 2500,
"condoFee": 650,
"propertyTax": 180,
"otherFees": 75.5,
"installmentAmount": 275,
"setupFee": 120,
"coverageLimit": 27500,
"rentCoverageLimit": 10000,
"remainingCoverageAmount": 27500,
"rentRemainingCoverageAmount": 10000,
"startBillingDate": "2026-10-01",
"terminationDate": null,
"createdAt": "2026-09-15T12:30:00",
"updatedAt": "2026-09-15T12:30:00"
}
}

Os dados de uma garantia foram alterados.

{
"Content-Type": "application/json",
"Webhook-Id": "string",
"Webhook-Type": "rental_insurance.created",
"Webhook-Timestamp": "string",
"Webhook-Attempt": 1,
"Webhook-Signature": "string"
}
{
"id": "string",
"type": "rental_insurance.created",
"occurredAt": "2026-09-15T15:30:00Z",
"apiVersion": "v1",
"data": {
"id": 812,
"externalId": "RI-2026-0042",
"status": "under_review",
"tenant": {
"cpfCnpj": "52998224725",
"name": "João da Silva",
"email": "joao.silva@example.com",
"birthDate": "1990-05-12",
"phoneNumber": "+5511999999999",
"profession": "Analista de sistemas"
},
"coTenants": [
{
"cpfCnpj": "39053344705",
"name": "Maria da Silva",
"email": "maria.silva@example.com",
"birthDate": "1992-08-20",
"phoneNumber": "+5511988888888"
}
],
"property": {
"externalId": "IMOVEL-1042",
"type": "apartment",
"address": {
"zipCode": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "Apto 81",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
},
"rentalAmount": 2500,
"condoFee": 650,
"propertyTax": 180,
"otherFees": 75.5,
"installmentAmount": 275,
"setupFee": 120,
"coverageLimit": 27500,
"rentCoverageLimit": 10000,
"remainingCoverageAmount": 27500,
"rentRemainingCoverageAmount": 10000,
"startBillingDate": "2026-10-01",
"terminationDate": "2026-09-15",
"createdAt": "2026-09-15T12:30:00",
"updatedAt": "2026-09-15T12:30:00"
}
}

O status do ciclo de vida de uma garantia foi alterado.

{
"Content-Type": "application/json",
"Webhook-Id": "string",
"Webhook-Type": "rental_insurance.created",
"Webhook-Timestamp": "string",
"Webhook-Attempt": 1,
"Webhook-Signature": "string"
}
{
"id": "string",
"type": "rental_insurance.status_changed",
"occurredAt": "2026-09-15T15:30:00Z",
"apiVersion": "v1",
"data": {
"id": 812,
"externalId": "RI-2026-0042",
"status": "under_review",
"tenant": {
"cpfCnpj": "52998224725",
"name": "João da Silva",
"email": "joao.silva@example.com",
"birthDate": "1990-05-12",
"phoneNumber": "+5511999999999",
"profession": "Analista de sistemas"
},
"coTenants": [
{
"cpfCnpj": "39053344705",
"name": "Maria da Silva",
"email": "maria.silva@example.com",
"birthDate": "1992-08-20",
"phoneNumber": "+5511988888888"
}
],
"property": {
"externalId": "IMOVEL-1042",
"type": "apartment",
"address": {
"zipCode": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "Apto 81",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
},
"rentalAmount": 2500,
"condoFee": 650,
"propertyTax": 180,
"otherFees": 75.5,
"installmentAmount": 275,
"setupFee": 120,
"coverageLimit": 27500,
"rentCoverageLimit": 10000,
"remainingCoverageAmount": 27500,
"rentRemainingCoverageAmount": 10000,
"startBillingDate": "2026-10-01",
"terminationDate": "2026-09-15",
"createdAt": "2026-09-15T12:30:00",
"updatedAt": "2026-09-15T12:30:00",
"previousStatus": "under_review"
}
}

A análise solicitou mais informações sobre uma garantia.

{
"Content-Type": "application/json",
"Webhook-Id": "string",
"Webhook-Type": "rental_insurance.created",
"Webhook-Timestamp": "string",
"Webhook-Attempt": 1,
"Webhook-Signature": "string"
}
{
"id": "string",
"type": "rental_insurance.created",
"occurredAt": "2026-09-15T15:30:00Z",
"apiVersion": "v1",
"data": {
"id": 812,
"externalId": "RI-2026-0042",
"status": "under_review",
"tenant": {
"cpfCnpj": "52998224725",
"name": "João da Silva",
"email": "joao.silva@example.com",
"birthDate": "1990-05-12",
"phoneNumber": "+5511999999999",
"profession": "Analista de sistemas"
},
"coTenants": [
{
"cpfCnpj": "39053344705",
"name": "Maria da Silva",
"email": "maria.silva@example.com",
"birthDate": "1992-08-20",
"phoneNumber": "+5511988888888"
}
],
"property": {
"externalId": "IMOVEL-1042",
"type": "apartment",
"address": {
"zipCode": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "Apto 81",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
},
"rentalAmount": 2500,
"condoFee": 650,
"propertyTax": 180,
"otherFees": 75.5,
"installmentAmount": 275,
"setupFee": 120,
"coverageLimit": 27500,
"rentCoverageLimit": 10000,
"remainingCoverageAmount": 27500,
"rentRemainingCoverageAmount": 10000,
"startBillingDate": "2026-10-01",
"terminationDate": "2026-09-15",
"createdAt": "2026-09-15T12:30:00",
"updatedAt": "2026-09-15T12:30:00"
}
}

Um contrato foi emitido para assinatura.

{
"Content-Type": "application/json",
"Webhook-Id": "string",
"Webhook-Type": "rental_insurance.created",
"Webhook-Timestamp": "string",
"Webhook-Attempt": 1,
"Webhook-Signature": "string"
}
{
"id": "string",
"type": "rental_insurance.created",
"occurredAt": "2026-09-15T15:30:00Z",
"apiVersion": "v1",
"data": {
"id": 812,
"externalId": "RI-2026-0042",
"status": "under_review",
"tenant": {
"cpfCnpj": "52998224725",
"name": "João da Silva",
"email": "joao.silva@example.com",
"birthDate": "1990-05-12",
"phoneNumber": "+5511999999999",
"profession": "Analista de sistemas"
},
"coTenants": [
{
"cpfCnpj": "39053344705",
"name": "Maria da Silva",
"email": "maria.silva@example.com",
"birthDate": "1992-08-20",
"phoneNumber": "+5511988888888"
}
],
"property": {
"externalId": "IMOVEL-1042",
"type": "apartment",
"address": {
"zipCode": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "Apto 81",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
},
"rentalAmount": 2500,
"condoFee": 650,
"propertyTax": 180,
"otherFees": 75.5,
"installmentAmount": 275,
"setupFee": 120,
"coverageLimit": 27500,
"rentCoverageLimit": 10000,
"remainingCoverageAmount": 27500,
"rentRemainingCoverageAmount": 10000,
"startBillingDate": "2026-10-01",
"terminationDate": "2026-09-15",
"createdAt": "2026-09-15T12:30:00",
"updatedAt": "2026-09-15T12:30:00"
}
}

O processo de assinatura do contrato foi concluído.

{
"Content-Type": "application/json",
"Webhook-Id": "string",
"Webhook-Type": "rental_insurance.created",
"Webhook-Timestamp": "string",
"Webhook-Attempt": 1,
"Webhook-Signature": "string"
}
{
"id": "string",
"type": "rental_insurance.created",
"occurredAt": "2026-09-15T15:30:00Z",
"apiVersion": "v1",
"data": {
"id": 812,
"externalId": "RI-2026-0042",
"status": "under_review",
"tenant": {
"cpfCnpj": "52998224725",
"name": "João da Silva",
"email": "joao.silva@example.com",
"birthDate": "1990-05-12",
"phoneNumber": "+5511999999999",
"profession": "Analista de sistemas"
},
"coTenants": [
{
"cpfCnpj": "39053344705",
"name": "Maria da Silva",
"email": "maria.silva@example.com",
"birthDate": "1992-08-20",
"phoneNumber": "+5511988888888"
}
],
"property": {
"externalId": "IMOVEL-1042",
"type": "apartment",
"address": {
"zipCode": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "Apto 81",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
},
"rentalAmount": 2500,
"condoFee": 650,
"propertyTax": 180,
"otherFees": 75.5,
"installmentAmount": 275,
"setupFee": 120,
"coverageLimit": 27500,
"rentCoverageLimit": 10000,
"remainingCoverageAmount": 27500,
"rentRemainingCoverageAmount": 10000,
"startBillingDate": "2026-10-01",
"terminationDate": "2026-09-15",
"createdAt": "2026-09-15T12:30:00",
"updatedAt": "2026-09-15T12:30:00"
}
}

Um comentário foi adicionado a uma garantia.

{
"Content-Type": "application/json",
"Webhook-Id": "string",
"Webhook-Type": "rental_insurance.created",
"Webhook-Timestamp": "string",
"Webhook-Attempt": 1,
"Webhook-Signature": "string"
}
{
"id": "string",
"type": "rental_insurance.comment_added",
"occurredAt": "2026-09-15T15:30:00Z",
"apiVersion": "v1",
"data": {
"id": 812,
"externalId": "RI-2026-0042",
"status": "under_review",
"tenant": {
"cpfCnpj": "52998224725",
"name": "João da Silva",
"email": "joao.silva@example.com",
"birthDate": "1990-05-12",
"phoneNumber": "+5511999999999",
"profession": "Analista de sistemas"
},
"coTenants": [
{
"cpfCnpj": "39053344705",
"name": "Maria da Silva",
"email": "maria.silva@example.com",
"birthDate": "1992-08-20",
"phoneNumber": "+5511988888888"
}
],
"property": {
"externalId": "IMOVEL-1042",
"type": "apartment",
"address": {
"zipCode": "01310-100",
"street": "Avenida Paulista",
"number": "1000",
"complement": "Apto 81",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
},
"rentalAmount": 2500,
"condoFee": 650,
"propertyTax": 180,
"otherFees": 75.5,
"installmentAmount": 275,
"setupFee": 120,
"coverageLimit": 27500,
"rentCoverageLimit": 10000,
"remainingCoverageAmount": 27500,
"rentRemainingCoverageAmount": 10000,
"startBillingDate": "2026-10-01",
"terminationDate": "2026-09-15",
"createdAt": "2026-09-15T12:30:00",
"updatedAt": "2026-09-15T12:30:00",
"comment": {
"text": "Documentos recebidos",
"creator": {
"name": "client-sample",
"serviceAccount": true
},
"createdAt": "2026-09-15T15:29:58Z"
}
}
}
Field Type Required Description
Content-Type string yes
Webhook-Id string yes
Webhook-Type EventType yes Valores: rental_insurance.created, rental_insurance.updated, rental_insurance.status_changed, rental_insurance.information_requested, rental_insurance.contract_issued, rental_insurance.signature_completed, rental_insurance.comment_added
Webhook-Timestamp string yes Horário Unix em segundos usado no conteúdo assinado.
Webhook-Attempt integer yes
Webhook-Signature string yes HMAC-SHA256 de <timestamp>.<corpo bruto da requisição> usando o segredo compartilhado.

Valores: rental_insurance.created, rental_insurance.updated, rental_insurance.status_changed, rental_insurance.information_requested, rental_insurance.contract_issued, rental_insurance.signature_completed, rental_insurance.comment_added

Valores: under_review, information_requested, approved, declined, expired, accepted, declined_by_tenant, active, terminated, archived

Field Type Required Description
id string yes
type EventType yes Valores: rental_insurance.created, rental_insurance.updated, rental_insurance.status_changed, rental_insurance.information_requested, rental_insurance.contract_issued, rental_insurance.signature_completed, rental_insurance.comment_added
occurredAt string (date-time) yes
apiVersion string yes
data object yes

O conteúdo inclui dados pessoais do inquilino e dos corresponsáveis. Restrinja o acesso e a retenção no sistema de destino.

Field Type Required Description
id integer (int64) yes
externalId string | null yes
status RentalInsuranceStatus yes Valores: under_review, information_requested, approved, declined, expired, accepted, declined_by_tenant, active, terminated, archived
tenant Tenant yes
coTenants array<CoTenant> yes
property Property yes
rentalAmount number yes
condoFee number yes
propertyTax number yes
otherFees number yes
installmentAmount number yes
setupFee number yes
coverageLimit number yes
rentCoverageLimit number yes
remainingCoverageAmount number yes
rentRemainingCoverageAmount number yes
startBillingDate string (date) | null yes
terminationDate string (date) | null yes
createdAt string (date-time) yes
updatedAt string (date-time) yes
Field Type Required Description
cpfCnpj string yes
name string yes
email string (email) yes
birthDate string (date) | null yes
phoneNumber string | null yes
profession string | null yes
Field Type Required Description
cpfCnpj string yes
name string yes
email string (email) yes
birthDate string (date) | null yes
phoneNumber string | null yes
Field Type Required Description
externalId string | null yes
type string yes
address Address yes
Field Type Required Description
zipCode string yes
street string yes
number string yes
complement string | null yes
neighborhood string yes
city string yes
state string yes