System Overview
Jobs
A Job represents a unit of work inside a Deck session. Jobs are how you tell Deck what to do — like retrieving documents, uploading files, or triggering an action.
Each Job consists of a Type and a Scope.
Example: Account Switch Workflow
Multiple workflows can run under the same Link, as long as they target the same sources and end-users.
To run a Job, you must provide a Job Code along with its input parameters. The results will be sent via Webhooks.
Types of Jobs
- Read Jobs — Extract information from the session
- Write Jobs — Perform actions within the session
Scopes of Jobs
- Retrieve documents — Statements, invoices, confirmations (PDFs, CSVs, screenshots)
- Retrieve metadata — Entity-level attributes, balances, logs
- Trigger an action — Simulate user actions (e.g. confirm a payment)
- Upload a document — Attach files to sessions or forms
- Inject a field — Modify or populate specific inputs
- Submit a form — Complete and send a multi-step form
Outputs of Jobs
Jobs return results via Webhooks, which may include:- A URL to download documents — PDFs, CSVs, screenshots
- Structured data — Normalized JSON payloads
- Completion status — Job success or failure, with context
Real-World Use of Jobs
Jobs are atomic — each one runs independently and returns its own result. You can chain multiple Jobs together in a Workflow to fulfill more complex tasks. Example: Payment WorkflowRead
Retrieve a balance.
Write
Submit a payment.
Read
Fetch a confirmation.
Write
Inject new banking details.
Read
Fetch a confirmation.
Entities
An Entity is a data-holding object discovered within a user session — such as an account, location, policy, or sub-user. Jobs are scoped to one or more entities. Deck automatically discovers entities during session creation. You can then:- Target specific entities using IDs or patterns
- Scope Jobs precisely (e.g., extract a bill from a specific account)
- Coordinate Jobs across many entities tied to a single connection
Examples of Entities Across Industries
| Industry | Entity Examples |
|---|---|
| Utilities | Account, Location, Meter |
| Insurance | Policy, Claim, Coverage package |
| Payroll | Employee, Payslip stream |
| Retail/Ecomm | Store ID, Seller account, Inventory group |
| Restaurant POS | Location, Register, Storefront |
| Education | Student profile, Course enrollment |
| Travel | Reservations, Itinerary, Passengers |
| Music | Artist, Contributor |