Capture requests are typically used to invite another user outside of your Org to capture a job for you. For example, a contractor can create a capture request that is sent to a homeowner. This sends the homeowner a text message and/or email inviting them to capture a Hover property, depending on your organization's preferences.
A Hover job is created along with the capture request. If you would like to create a job without notifying an external stakeholder to capture the property, use the create a job endpoint to create a job record.
When a capture request is created, either the user requesting the capture, or the user receiving the capture request can perform the photo capture. Once the requested capture is complete, both the capturing user and creator get access to the job. Upon creation of a capture request, Hover will send notifications to capturing_user_email and capturing_user_phone, instructing them to download the app and take the photos.
It is possible for either of the users involved in a capture request to complete the capture. To identify the user who completed a capture request, you can reference the captured_user_id attribute on a completed job object.
Connect Request vs Capture Request
The terms "Connect request" and "Capture request" are often used interchangably by our customers and do mean the same thing.
Getting a Capture Request Link
To learn how to get a link to a Capture Request, please see our guide here.
Response Code Snippet
See an example JSON code snippet of a capture request here, then follow below to learn more about the request, and what makes up the responses.
{
"requested_captures": {
"pagination": {
"current_page": 5,
"total_pages": 5,
"total": 106
},
"results": [
{
"id": 1521811,
"capturing_user_name": "Lucille Bluth",
"capturing_user_phone": "5558675309",
"capturing_user_email": "[email protected]",
"capturing_user_id": null,
"requesting_user_id": 1153372,
"identifier": "Tddf5w",
"claim_number": null,
"state": "new",
"signup_type": "homeowner",
"job_attributes": {
"name": "Vacation Home",
"location_line_1": "123 Hover Way",
"location_line_2": "Apartment 22",
"location_city": "Los Angeles",
"location_region": "CA",
"location_postal_code": "90210",
"external_identifier": "8675309",
"deliverable_id": 3,
"client_identifier": "4ea9fdab-3fbb-482d-bf6d-db343b94951b"
},
"captured_user_id": null,
"pending_job_id": 10168629,
"requesting_user": {
"name": "Integration User",
"email": "[email protected]",
"org": {
"id": 492855,
"name": "Bluth Company",
"preferences": {
"external_identifier_label": "Lead Number",
"external_identifier_required": false
}
}
},
"org_id": 492855
}
]
},
"capture_requests": {
"pagination": {
"current_page": 5,
"total_pages": 5,
"total": 106
},
"results": []
}
}