Read through the API and receive events by webhook.
API keys provide permitted data read-only. Configure webhook subscriptions and initiate signed test dispatches, and optionally receive case, hearing and document create/update/delete events of a selected branch automatically. Delivery is at-least-once; the receiver must deduplicate.
Selectable subscription events
Example subscription options; automatic delivery runs once enabled on the subscription with a branch selected.
| Resource | Created | Updated | Deleted |
|---|---|---|---|
| Case | Selected | Selected | Not selected |
| Hearing | Selected | Selected | Selected |
| Document | Selected | Not selected | Not selected |
API keys provide read-only access to case, client, hearing, document metadata and invoice data. Current user permissions, company and branch scope and plan conditions apply; write operations or unrestricted document file access are not promised.
01/03
Test and delivery result.
A test dispatch initiated by an authorised user and automatic deliveries are signed, and each attempt result is recorded. A successful recipient response does not prove that an ERP operation completed. Automatic delivery is retried on transient failures (timeout, network error, 408, 429, 5xx) up to five attempts at growing intervals; other responses are not retried.
Test request
IllustrationAn authorised user starts a test.
Destination check
To be validatedAddress and subscription conditions are evaluated.
Signed test
ConditionalDispatch depends on security checks.
Recipient response
To be reviewedA response does not prove ERP processing completed.
Test result
DraftSuccess or failure is logged; this is not a real operation record.
Illustrative test flow; not evidence of real delivery or recipient processing.
- Signed
- Verifying the signed request is your receiving system's responsibility; the signature covers the timestamp and delivery ID.
- Failure review
- Review a failed result. Automatic delivery is retried on its own for transient failures; once attempts are exhausted the event is not resent, while a test can be initiated again.
- Test
- An authorised user initiates a test dispatch without waiting for a real event; automatic delivery is triggered by a real event.
- Record
- The result of test and automatic delivery attempts can be reviewed in the integration log.
02/03
A subscription is set up in five steps.
Configure event options and the target address. Security and permission checks apply; automatic delivery needs enabling on the subscription, a branch selection and a signing key.
09:20 Enter the address and the events
Illustrative setup and test flow; not evidence of real delivery.
03/03
What do teams ask about webhooks and the API?
- 01/08
Which events trigger a webhook?
Create, update and delete events can be selected for cases, hearings and documents. Selected events are sent for records created in the selected branch after automatic delivery is enabled on the subscription; saving does not send past events. The payload carries only the event name, record and delivery IDs and the time, not case content. An authorised user can also initiate a signed test request.
- 02/08
How do I know a notification comes from Vekilaw?
Verify the signed request in your receiving system and reject requests that cannot be verified. The signature is computed with your key over the timestamp, delivery ID and body, and arrives in a request header. This example page does not show actual signature verification or delivery results.
- 03/08
What happens if a notification cannot be delivered?
Review the result in the log. Automatic delivery is retried on timeout, network error, 408, 429 and 5xx responses up to five attempts at growing intervals; other responses, and events whose attempts are exhausted, are not resent. For tests, an authorised user can initiate another test when destination and subscription conditions permit.
- 04/08
How do I get an API key?
Current plan scope and API key management permission are required. An authorised user creates, rotates or revokes a key in Settings. The plaintext key is shown once on creation or rotation; a plan name alone does not grant access.
- 05/08
Which data can I reach through the API?
Read-only access is provided to case, client, hearing, document metadata and invoice data. The creating user current company, branch and operation permissions apply. Write operations or unrestricted document file access are not available. Manage permissions through roles and permissions.
- 06/08
Can another firm's data reach my address?
No. Each company's subscriptions and API access cover only its own data. The separation of data and the assurance model are described on the security page.
- 07/08
What do teams typically build with webhooks and the API?
Use permitted data from the read-only API in internal reporting. Webhooks let you learn of case, hearing and document changes, and a signed test dispatch validates the connection; automatic CRM/ERP record creation or document file copying is not offered. See the integrations page for other connection statuses.
- 08/08
Where do the records behind the webhook events live?
Case, hearing and document records are kept in their product modules. Automatic delivery runs only with an enabled subscription, a selected branch and sufficient permissions; if permissions or the subscription change, pending deliveries are not sent. See case management.