Available Information Requests Webhook Events enable your application to receive real-time notifications about updates and changes specifically related to information request processes. These events provide detailed insights into the status of assignments, information requests states, and document uploads, ensuring seamless tracking and automation for all aspects of the information request workflow.
This is the body of the post we'll send to you:
{
"type": "information_requests.assignment.updated",
"information_requests": {
"id": "irq_mock123456789",
"name": "Mock Webhook Test",
"created_at": "2025-01-21T10:00:00.000Z",
"updated_at": "2025-01-21T11:30:00.000Z",
"template_id": "irt_mocktemplate123",
"entity_validation_id": "evl_mockentity123",
"recipient_url": "https://example.com/process/irq_mock123456789",
"analysis_chat_started_generation_at": null,
"created_by_id": "usr_mockcreator123",
"status": "pending",
"assignments": [
{
"user_id": "usr_mockuser123",
"user_email": "[email protected]",
"role": "responsible",
"status": "approved",
"comment": null
},
{
"user_id": "usr_mockreviewer456",
"user_email": "[email protected]",
"role": "reviewer",
"status": "rejected",
"comment": "Document is incomplete."
}
],
"files": [],
"crm_id": "crm_mock123456",
"erp_id": "ERP_MOCK_TEST",
"documents": [
{
"id": "doc_mock123456",
"requestable_document": {
"id": "reqdoc_mock123",
"name": "Mock Tax Certificate"
},
"data": {
"rfc": "MOCKRFC12345",
"curp": "MOCKCURP12345",
"entity_name": "John Doe",
"capital_regime": "Individual",
"commercial_name": "John's Mock Business",
"start_date": "2023-01-01",
"status": "Active",
"last_status_change": "2023-01-01",
"economic_activities": [
{
"end_date": null,
"percentage": "100",
"start_date": "2023-01-01",
"description": "Mock Economic Activity"
}
],
"regimes": [
{
"name": "Salary Regime",
"end_date": null,
"start_date": "2023-01-01"
}
],
"obligations": [
{
"due_date": "April 30, annually",
"end_date": null,
"start_date": "2023-01-01",
"description": "Annual Tax Declaration"
}
]
},
"extracted_at": "2025-01-21T11:00:00.000Z",
"failed_at": null,
"sent_to_extraction_at": "2025-01-21T10:30:00.000Z",
"file": {
"id": "file_mock123456",
"public_url": "https://example.com/uploads/mockdocument.pdf",
"name": "Mock Tax Certificate",
"created_at": "2025-01-21T10:00:00.000Z",
"label": null
},
"review_status": "ai_approved",
"alerts": [
"expired",
"mismatch"
],
"answered_at": "2025-01-21T11:00:00.000Z"
}
],
"analysis_chat": null,
"webhook_url": "https://webhook.site/mock-url-123456",
"declaration_responses": []
}
}
note that this example response was trimmed for demonstration purposes. You can check the full information request object here
Below is a list of webhook events supported by our API. These events provide real-time notifications about changes or updates in your processes.
Event Types
| Event Type | Description |
|---|---|
information_requests.assignment.updated | Triggered when an assignment within a process changes its state. For example, when a reviewer marks an assignment as "Meets Requirements". |
information_requests.status.updated | Triggered when the overall process status changes. For instance, when the responsible party marks the entity as approved or rejected. |
information_request.all_items_collected | Triggered when all required documents have been uploaded by a user. For example, when a process requires three documents and the user uploads all three. |