Contract webhooks
The assignment contract sends two types of webhook: one on every contract status change and one when a product of the contract is activated. Both are sent to the manager, to the assignor and, if there is one, to the contract's consultant — to each one that has a webhook configured. Signature, resending and configuration: see Webhook Authentication.
Contract status change
webhook_type: assignment_contract.assignment_contract_status_change
{
"data": {
"assignment_contract_key": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"status": "denied",
"external_id": "Contract number 550",
"denial_reason": "Insufficient assignor documentation"
},
"webhook_type": "assignment_contract.assignment_contract_status_change",
"webhook_datetime": "2025-01-22T20:30:23Z"
}
| Field | Description |
|---|---|
data.assignment_contract_key | Contract key. |
data.status | New contract status. See Enumerators. |
data.external_id | external_id sent in the contract request, or null. |
data.denial_reason | Rejection reason provided by the manager. null outside the denied status. |
data.assignment_contract_new_status | Only present when status is signed, with the value contract_signed. |
Example of a signed contract:
{
"data": {
"assignment_contract_key": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"status": "signed",
"external_id": "Contract number 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"
}
Statuses that trigger the webhook:
| Status | When |
|---|---|
pending_manager_approval | A contract proposed by the consultant awaits the manager's decision. |
pending_assignor_registry_release | The assignor's registration is still under analysis. |
pending_signature_submission | The template requires manual submission for signature. |
sending_to_signature | The contract is being sent to CertifiQI. |
pending_signature | Available for the parties to sign. |
waiting_escrow_data / pending_escrow_activation | Escrow account steps (only in templates with an escrow account). |
signed | All documents have been signed. The products start being activated. |
suspended | Contract suspended; the products become inactive. Returns to signed upon reactivation. |
denied | The manager rejected the contract. |
canceled | The contract was canceled. |
Product activated
webhook_type: assignment_contract.product_status_change
Sent when a product's assignment pipeline finishes being configured, after the contract is signed. This is where the assignment_configuration_key arrives, used to assign assets between the fund and the assignor. Contracts with more than one product generate one webhook per product.
{
"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"
}
| Field | Description |
|---|---|
data.product_key | Product key. To find out which contract it belongs to, query the contract in Contract Query. |
data.assignment_configuration_key | Key of the assignment configuration created for the product. |
data.status / data.product_new_status | Always active in this webhook. |