Jobs

Working with the data.

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.

You need to provide a Job Code along with its input parameters to run the Job, and the results will come as Webhooks.

Each job is composed of a Type and a Scope.


Types of Jobs

  • Read Jobs: Extract information from the session
  • Write Jobs: Perform actions inside the session

Scopes of Jobs

  • Retrieve documents – Statements, invoices, confirmations (e.g. PDFs, CSVs, screenshots)
  • Retrieve metadata – Entity-level attributes, balances, activity logs
  • Trigger an action – Simulate a button press or workflow (e.g. confirm a payment)
  • Upload a document – Attach a file to a session or form
  • Inject a field – Modify or populate specific inputs
  • Submit a form – Complete and submit a multi-step flow

Outputs of Jobs

As stated above, what you will receive from any job is Webhooks. This may contain structured data, or a link to fetch what we found, such as:

  • Documents — PDFs, CSVs, screenshots
  • Structured data — Normalized JSON payloads
  • Completion status — Whether the job succeeded or failed, with context

Real-world use of Jobs

Jobs are designed to be atomic: each job runs independently on Deck and returns its own status. Multiple Jobs may be run sequentially as a Workflow .

Simply put, a workflow represents a logical chain of jobs that together fulfill a specific outcome. For example, a payment workflow might involve:

Retrieving a balance (read)

Submitting a payment (write)

Fetching a confirmation (read)


Multiple workflows can operate under the same Link, as long as they target the same set of sources and end-users. For instance, alongside the payment workflow, a developer might define an account switch workflow, composed of:

Injecting new banking details (write)

Fetching a confirmation (read)


Entities

An Entity is a data-holding object discovered inside a user session — such as an account, location, policy, or sub-user. Jobs are scoped to one or more entities, making them the key targets for reading and writing operations.

Deck automatically discovers entities during session creation. Developers can then:

  • Target specific entities within a connection, using IDs or patterns
  • Scope Job actions precisely — for example, extracting a bill from a specific account, or submitting a form tied to a single account
  • Coordinating Jobs across hundreds or thousands of entities tied to the same connection.

This enables Jobs to focus on the right units of work, even in large and dynamic environments.

Examples of entities across industries:

VerticalEntity examples
UtilitiesAccount, Location, Meter
InsurancePolicy, Claim, Coverage package
PayrollEmployee, Payslip stream
Retail/EcommStore ID, Seller account, Inventory group
Restaurant POSLocation, Register, Storefront
EducationStudent profile, Course enrollment
TravelReservations, Itinerary, Passengers
MusicArtist, Contributor