Skip to main content

Integration guideSeal API and Scripts

Seal Scripts

Use Python to connect systems and automate process-specific checks.

Illustration of a seal beside a laptop showing a data table and an evidence binder linked by a red thread.

Seal Scripts and SealSeal API and Scripts

Seal reads
Responses from the services a Script calls
Writes back
Calls to an external service, after an event or on a schedule
Source of truth
Agreed when scoped
Set up
Scoped with your team
Neil › Draft Script and test run
draft

Draft a Script that checks each new result against its specification and flags exceptions.

Neil

  • I’ll propose the Script and run it against test records first. Review it before it’s published through a change set.
Reads
Your Seal records and specifications
Returns
  • Proposed Python Script
  • Results from the test records
  • Assumptions for your team to review
Illustrative work with Seal Scripts: a request to Neil, the source it reads and the draft it returns for your review.

1What’s connected.

Write versioned Python Scripts in Seal to check data, update several records, call an external service or run after an event or on a schedule. Scripts are edited in a change set, tested and published like other Seal records.

Connection setup and permissions

Use Seal’s APIs or scripting engine for a connection tailored to your process. Agree the data mapping, access and direction of transfer before implementation.

2Start with the job.

Tell us what Neil needs to do and which records it needs. We’ll confirm the interface, permissions and implementation scope with your team.

Discuss this connection →

3Before it goes live.

Access and any write-back

Define which records are in scope and whose permissions apply. Whether the connection writes back at all is a separate decision, with its own mapping and approval.

Data and failure handling

Agree the field mapping, identifiers, units and source of record. Test missing or duplicate data, interrupted transfers and recovery before relying on the connection.

Verification and release

Review the configured connection for its intended use. Keep the requirements, checks and evidence with the change, and approve the release through your team’s controls.

Read the assurance detail →