How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Benchling Events API

The Events system allows external services to subscribe to events that are triggered in Benchling (e.g. plasmid registration, request submission, etc).

Benchling Events API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a changelog, and a status page.

This API exposes 1 operation across 1 path, and defines 124 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, /api/v2.

1 operations 1 paths 124 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{tenant}.benchling.com/api/v2
Authentication
HTTP Basic, HTTP Basic, OAuth 2.0
License
Resource Areas
1

Authentication & Security 3

Benchling Events API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicApiKeyAuth). It accepts HTTP basic authentication (basicClientIdSecretAuth). It supports OAuth 2.0 (oAuth) using the clientCredentials flow. By default, every request must be authenticated.

  • basicApiKeyAuth — Use issued API key for standard access to the API
  • basicClientIdSecretAuth — Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
  • oAuth — OAuth2 Client Credentials flow intended for service access

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Events 1

The Events system allows external services to subscribe to events that are triggered in Benchling (e.g. plasmid registration, request submission, etc).

GET
/events
List Events
listEvents 6 params → 200400

Schemas 124

The contract defines 124 schemas that model the data the API accepts and returns. The most detailed are Entry (18 properties), GenericEntity (17 properties), StageEntry (16 properties), AssayRun (14 properties). Each schema is shown below with its type and property counts.

AutomationOutputProcessorCompletedV2Event
EntryTableRow
object
Each has property 'cells' that is an array of cell objects
1 property
StageEntryCreatedEvent
EventsPaginatedList
object
2 properties
ChartNotePart
WorkflowOutputUpdatedFieldsEvent
CheckboxNotePart
One "line" of a checklist
PartySummary
object
3 properties
EntryTable
object
Actual tabular data with rows and columns of text on the note.
3 properties
CustomField
object
1 property
UserSummary
RequestTaskBase
object
A request task.
1 property 1 required
FieldType
string
RequestTeamAssignee
object
1 property
AssayRun
object
14 properties
RequestTask
object
A request task.
1 property
RequestSampleWithEntity
object
2 properties 1 required
RequestUpdatedFieldsEvent
StructuredTableColumnInfo
object
3 properties
EntrySchema
object
Entry schema
3 properties
EntryUpdatedReviewRecordEvent
AutomationInputGeneratorCompletedV2BetaEvent
WorkflowTaskGroup
RequestSampleGroupSamples
object
The key for each (Legacy) RequestSample should match one of the samplesSchema[n].name property in the request schema json.
WorkflowRouterFunction
object
4 properties
AssayRunUpdatedFieldsEvent
WorkflowTaskGroupUpdatedWatchersEvent
ExternalFileNotePart
An attached user-uploaded file
LabAutomationTransform
object
9 properties
BaseError
object
3 properties
CustomFields
object
EntryCreatedEvent
StructuredTableApiIdentifiers
object
3 properties
GenericEntity
object
17 properties
WorkflowTaskGroupBase
RequestTaskBaseFields
object
Shared fields for Legacy Request Tasks and related endpoints.
2 properties
InventoryPlateTableNotePart
WorkflowTaskBase
WorksheetUpdatedReviewSnapshotBetaEvent
AutomationInputGeneratorCompletedV2Event
WorkflowTaskGroupMappingCompletedEvent
Field
object
5 properties 1 required
Blob
object
5 properties
ReviewSnapshot
object
5 properties
BaseNotePart
object
2 properties
AssayRunCreatedEvent
SimpleNotePart
Simple note parts include the following types: - 'text': plain text - 'code': preformatted code block - 'listbullet': one "line" of a bulleted list - 'listnumb…
LookupTableNotePart
Event
EntityRegisteredEvent
WorkflowTaskStatus
object
3 properties
AssayRunValidationStatus
string
Must be either VALID or INVALID
PlateCreationTableNotePart
AutomationTransformStatusPendingEventV2Event
AutomationTransformStatusFailedEventV2Event
AppCanvasNotePart
WorkflowOutputNodeDetails
object
3 properties
WorksheetReviewChanges
object
Contents include basic worksheet metadata along with its review changes, including any snapshot information if present.
9 properties
EntryUpdatedFieldsEvent
Folder
object
5 properties
InventoryContainerTableNotePart
WorkflowNodeTaskGroupSummary
EntryTableCell
object
2 properties
WorkflowOutput
BoxCreationTableNotePart
RequestUserAssignee
object
1 property
WorkflowEndNodeDetails
object
3 properties
StageEntry
object
A notebook entry used for execution of one or more stage runs in a legacy workflow.
16 properties
EntryUpdatedAssignedReviewersEvent
RegistrationOrigin
object
2 properties
WorkflowRootNodeDetails
object
3 properties
RegistrationTableNotePart
AutomationFile
object
5 properties
AutomationOutputProcessorUploadedV2BetaEvent
WorkflowTaskSummary
object
2 properties
StageEntryUpdatedReviewRecordEvent
AutomationOutputProcessorCompletedV2BetaEvent
WorkflowTaskUpdatedFieldsEvent
WorkflowOutputCreatedEvent
WorkflowRouterNodeDetails
object
4 properties
ResultsTableNotePart
Fields
object
WorkflowFlowchartNodeConfig
object
3 properties
TeamSummary
WorkflowTaskGroupCreatedEvent
Entry
object
Entries are notes that users can take. They're organized by "days" (which are user-configurable) and modeled within each day as a list of "notes." Each note ha…
18 properties
EntryNotePart
object
Notes are the main building blocks of entries. Each note corresponds roughly to a paragraph.
AssayRunNotePart
WorkflowTaskSchemaSummary
object
2 properties
EntryDay
object
3 properties
SchemaSummary
object
2 properties
RequestCreatedEvent
TextBoxNotePart
ReviewChange
object
6 properties
RequestBase
object
A Legacy Request is an ask to perform a service, e.g. produce a sample or perform assays on a sample. Requests are usually placed to another team or individual…
RequestSampleWithBatch
object
2 properties 1 required
EventBase
object
5 properties
WorkflowTaskGroupSummary
object
3 properties
WorkflowTaskCreatedEvent
RequestStatus
string
EntryUpdatedReviewSnapshotBetaEvent
EntryLink
object
Links are contained within notes to reference resources that live outside of the entry. A link can target an external resource via an http(s):// hyperlink or a…
3 properties
LabAutomationBenchlingAppErrors
object
1 property
RequestSampleGroup
object
2 properties
AutomationTransformStatusSucceededEventV2Event
BadRequestError
object
1 property
WorkflowTaskUpdatedScheduledOnEvent
Request
WorkflowTaskUpdatedAssigneeEvent
TableNotePart
A table with rows and columns of text
WorkflowTaskUpdatedStatusEvent
MixturePrepTableNotePart
UpdateEventMixin
object
1 property
WorkflowTask
AutomationTransformStatusRunningEventV2Event
EntryReviewProcess
object
5 properties
AutomationOutputProcessorUploadedV2Event
StageEntryUpdatedFieldsEvent
ArchiveRecord
object
1 property
WorkflowTaskNodeDetails
object
3 properties
WorkflowTaskExecutionOrigin
object
The context into which a task was executed
3 properties
StageEntryUpdatedAssignedReviewersEvent
WorkflowOutputSummary
object
2 properties
CreationOrigin
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-events-api-openapi.yml Raw ↑

Other APIs Benchling publishes across the network.

Benchling AA Sequences API
Benchling Apps API
Benchling Assay Results API
Benchling Assay Runs API
Benchling Audit API
Benchling Authentication API
Benchling Blobs API
Benchling Boxes API
Benchling Codon Usage Tables API
Benchling Connect API
Benchling Containers API
Benchling Custom Entities API
Where this information came from

This is an independent, third-party profile of Benchling Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.