FormCreated
Run when an intake is initiated.
Required: form_id
- form_id may be * to match any intake form.
{
"type": "FormCreated",
"config": {
"form_id": "form_..."
}
}
{
"actions": [
{
"id": "add_form_e4fde87eb6b3",
"type": "AddAdditionalForm",
"config": {
"form_id": "form_yx01zmqEpzZ1ioBpYVZPa2RK"
}
},
{
"id": "sync_form_fields_05a354143fb1",
"type": "SyncFormFields",
"config": {
"field_mappings": [
{
"source_field": "form1_0_subform_0_pt2line4a_familyname_0",
"target_field": "form1_0_subform_0_lastname_0"
},
{
"source_field": "form1_0_subform_0_pt2line4b_givenname_0",
"target_field": "form1_0_subform_0_firstname_0"
},
{
"source_field": "form1_0_subform_0_pt2line4c_middlename_0",
"target_field": "form1_0_subform_0_middlename_0"
},
{
"source_value": "client.email",
"target_field": "form1_0_subform_0_email_0"
}
],
"source_form_id": "form_raeA4zvVQBrNCAgQ31PM6B9W",
"target_form_id": "form_yx01zmqEpzZ1ioBpYVZPa2RK"
}
}
],
"trigger": {
"type": "FormCompleted",
"config": {
"form_id": "form_raeA4zvVQBrNCAgQ31PM6B9W"
}
}
}
An automation has one trigger and an ordered list of actions. This reference is also the contract available to the Deep Docket Assistant.
{
"trigger": {
"type": "FormCompleted",
"config": {
"form_id": "form_..."
}
},
"actions": [
{
"id": "create_follow_up_tasks",
"type": "CreateTaskList",
"config": {
"tasks": [
{
"name": "Review submission",
"due_date": {
"days_from_now": 2
}
}
]
}
}
]
}
The event in trigger.type that starts an automation.
FormCreated
Run when an intake is initiated.
Required: form_id
{
"type": "FormCreated",
"config": {
"form_id": "form_..."
}
}
FormCompleted
Run when an intake is submitted.
Required: form_id
{
"type": "FormCompleted",
"config": {
"form_id": "form_...",
"conditions": [
{
"type": "form_field_checked",
"field": "ready_to_file"
}
]
}
}
DocumentRequestCompleted
Run when a matching document request is completed.
Required: document_request_template_id
{
"type": "DocumentRequestCompleted",
"config": {
"document_request_template_id": "doc_req_..."
}
}
DocumentSignedByAll
Run after every signer completes a document.
Required: signable_document_template_id
{
"type": "DocumentSignedByAll",
"config": {
"signable_document_template_id": "sign_doc_..."
}
}
FinalizedFormPdf
Run after all conditionally required filled or signed form PDFs exist.
Required: forms
{
"type": "FinalizedFormPdf",
"config": {
"forms": [
{
"id": "form_...",
"generation_type": "form_filled"
},
{
"id": "form_...",
"generation_type": "signable_from_filled",
"conditions": [
{
"type": "form_field_checked",
"field": "include_spouse",
"form_id": "form_..."
}
]
}
]
}
}
StageUpdated
Run when a matter moves from or to a stage.
At least one: from_stage_id, to_stage_id
{
"type": "StageUpdated",
"config": {
"to_stage_id": "stage_..."
}
}
AutomationCompleted
Run after a named automation completes successfully.
Required: automation_id
{
"type": "AutomationCompleted",
"config": {
"automation_id": "aut_..."
}
}
Actions run in array order. Give every action a stable, unique
id.
CreateAccessGrant
Grant configured matter access to the client or another participant.
Required: access_grant
{
"id": "grant_client_access",
"type": "CreateAccessGrant",
"config": {
"access_grant": {
"name": "Client access",
"account_user_id": "client",
"expiry_days": 30
}
}
}
CreateDocumentRequest
Create a document request from a template.
Required: document_request_template_id, role_mappings
{
"id": "request_passport",
"type": "CreateDocumentRequest",
"config": {
"document_request_template_id": "doc_req_...",
"role_mappings": {
"recipient": "client"
}
}
}
CreateSignableDocument
Create a signable document from a template.
Required: signable_document_template_id, role_mappings
{
"id": "prepare_signature_copy",
"type": "CreateSignableDocument",
"config": {
"signable_document_template_id": "sign_doc_...",
"role_mappings": {
"client": "client"
}
}
}
UpdateStage
Move the current matter to a named stage.
Required: new_stage_id
{
"id": "move_to_review",
"type": "UpdateStage",
"config": {
"new_stage_id": "stage_..."
}
}
AddAdditionalForm
Add another intake form to the current matter.
Required: form_id
{
"id": "add_follow_up",
"type": "AddAdditionalForm",
"config": {
"form_id": "form_..."
}
}
SyncFormFields
Copy explicitly mapped structured answers between forms.
Required: source_form_id, target_form_id, field_mappings
{
"id": "copy_contact_details",
"type": "SyncFormFields",
"config": {
"source_form_id": "form_...",
"target_form_id": "form_...",
"field_mappings": [
{
"source_field": "petitioner_name",
"target_field": "applicant_name"
},
{
"source_value": "client.email",
"target_field": "applicant_email"
}
]
}
}
CombineFormPdfs
Combine conditionally selected filled or signed PDFs in order.
Required: output_name, forms
{
"id": "combine_filing_packet",
"type": "CombineFormPdfs",
"config": {
"output_name": "Filing packet",
"forms": [
{
"id": "form_...",
"generation_type": "form_filled"
}
]
}
}
SendNotification
Send an in-app notification and optionally an email.
Required: recipient, message, send_email
{
"id": "notify_client",
"type": "SendNotification",
"config": {
"recipient": "client",
"title": "Documents ready",
"message": "Your documents are ready for review.",
"send_email": true,
"tab": "documents"
}
}
CreateTaskList
Create an ordered list of unassigned matter tasks.
Required: tasks
{
"id": "create_review_tasks",
"type": "CreateTaskList",
"config": {
"tasks": [
{
"name": "Review submission",
"priority": "high",
"due_date": {
"days_from_now": 2
}
},
{
"name": "Prepare filing package",
"priority": "normal"
}
]
}
}
Conditions evaluate intake answers by field variable_name.
An array means AND; use a group object for another operator.
form_field_checkedform_field_equalsform_field_containsANDORXOR{
"operator": "OR",
"conditions": [
{
"type": "form_field_checked",
"field": "include_spouse"
},
{
"type": "form_field_equals",
"field": "case_type",
"value": "family"
}
]
}