Webhooks do contrato
O contrato de cessão envia dois tipos de webhook: um a cada mudança de status do contrato e um quando um produto do contrato é ativado. Os dois são enviados para a gestora, para o cedente e, se houver, para a consultoria do contrato — para cada um que tenha webhook configurado. Assinatura, reenvio e configuração: veja Autenticação de Webhooks.
Mudança de status do contrato
webhook_type: assignment_contract.assignment_contract_status_change
{
"data": {
"assignment_contract_key": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"status": "denied",
"external_id": "Contrato número 550",
"denial_reason": "Documentação do cedente insuficiente"
},
"webhook_type": "assignment_contract.assignment_contract_status_change",
"webhook_datetime": "2025-01-22T20:30:23Z"
}
| Campo | Descrição |
|---|---|
data.assignment_contract_key | Chave do contrato. |
data.status | Novo status do contrato. Ver Enumeradores. |
data.external_id | external_id enviado no pedido do contrato, ou null. |
data.denial_reason | Motivo da recusa informado pela gestora. null fora do status denied. |
data.assignment_contract_new_status | Só presente quando status é signed, com o valor contract_signed. |
Exemplo do contrato assinado:
{
"data": {
"assignment_contract_key": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"status": "signed",
"external_id": "Contrato número 550",
"denial_reason": null,
"assignment_contract_new_status": "contract_signed"
},
"webhook_type": "assignment_contract.assignment_contract_status_change",
"webhook_datetime": "2025-01-22T20:30:23Z"
}
Status que disparam o webhook:
| Status | Quando |
|---|---|
pending_manager_approval | Contrato proposto pela consultoria aguarda a decisão da gestora. |
pending_assignor_registry_release | O cadastro do cedente ainda está em análise. |
pending_signature_submission | O template exige envio manual para assinatura. |
sending_to_signature | O contrato está sendo enviado à CertifiQI. |
pending_signature | Disponível para assinatura das partes. |
waiting_escrow_data / pending_escrow_activation | Etapas de conta escrow (só em templates com conta escrow). |
signed | Todos os documentos foram assinados. Os produtos começam a ser ativados. |
suspended | Contrato suspenso; os produtos ficam inactive. Volta a signed na reativação. |
denied | A gestora recusou o contrato. |
canceled | O contrato foi cancelado. |
Produto ativado
webhook_type: assignment_contract.product_status_change
Enviado quando a esteira de cessão de um produto termina de ser configurada, depois da assinatura do contrato. É aqui que chega a assignment_configuration_key, usada para ceder ativos entre o fundo e o cedente. Contratos com mais de um produto geram um webhook por produto.
{
"data": {
"product_key": "57efbd9f-0917-4c79-9a43-bc8f1039fc78",
"assignment_configuration_key": "372f0449-4043-4523-9f0f-dff70c65b9c9",
"status": "active",
"product_new_status": "active"
},
"webhook_type": "assignment_contract.product_status_change",
"webhook_datetime": "2025-01-22T20:30:23Z"
}
| Campo | Descrição |
|---|---|
data.product_key | Chave do produto. Para saber a qual contrato ele pertence, consulte o contrato em Consulta de Contrato. |
data.assignment_configuration_key | Chave da configuração de cessão criada para o produto. |
data.status / data.product_new_status | Sempre active neste webhook. |