V2 EventBridge JSON Examples
JSON examples for supported V2 Benchling EventBridge event payloads.
This page is for Developer Documentation.
JSON Examples
JSON Structure of all the V2 events.
v2.assayRun.created
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.assayRun.created","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"assayRun": {"archiveRecord": {"reason": "string"},"createdAt": "string","creator": {"handle": "string","id": "string","name": "string"},"entryId": "string","fields": {},"id": "string","isReviewed": true,"projectId": "string","schema": {"id": "string","name": "string"},"validationComment": "string","validationSchema": "string","apiURL": "string"},"eventType": "v2.assayRun.created"}}
v2.assayRun.updated.fields
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.assayRun.updated.fields","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"assayRun": {"archiveRecord": {"reason": "string"},"createdAt": "string","creator": {"handle": "string","id": "string","name": "string"},"entryId": "string","fields": {},"id": "string","isReviewed": true,"projectId": "string","schema": {"id": "string","name": "string"},"validationComment": "string","validationSchema": "string","apiURL": "string"},"eventType": "v2.assayRun.updated.fields"}}
v2.automationFileTransform.updated.status.running
This payload is the same for:
v2.automationFileTransform.updated.status.runningv2.automationFileTransform.updated.status.pendingv2.automationFileTransform.updated.status.succeededv2.automationFileTransform.updated.status.failed
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.automationFileTransform.updated.status.running","source": "aws.partner...","account": "123123123123","time": "2021-12-02T17:26:57Z","region": "us-west-1","resources": [],"detail": {"updates": ["status"],"transform": {"id": "aopf_id","type": "CUSTOM","apiURL": "https://tenant.benchling.com/api/v2/automation-file-transforms/aopf_id","blobId": "XXXX-XXXX...","errors": {},"status": "RUNNING","modifiedAt": "2021-12-02T17:26:57.502595+00:00","customTransformId": "app_id"},"deprecated": false,"excludedProperties": [],"id": "evt_id","createdAt": "2021-12-02T17:26:57.502595+00:00","eventType": "v2.automationFileTransform.updated.status.running"}}
v2.entity.registered
The entity resource has the common fields from the following: DNA Sequence Resource, DNA Oligo Resource, RNA Oligo Resource, AA Sequence Resource, and Custom Entity Resource.
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.entity.registered","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"entity": {"aliases": ["string"],"archiveRecord": {"reason": "string"},"authors": [{"handle": "string","id": "string","name": "string"}],"createdAt": "2020-05-04T09:42:00+00:00","creator": {"handle": "string","id": "string","name": "string"},"customFields": {},"entityRegistryId": "string","fields": {},"folderId": "string","id": "string","modifiedAt": "2020-05-04T09:42:00+00:00","name": "string","registrationOrigin": {"originEntryId": "string","registeredAt": "2024-02-26T17:08:06.386Z"},"registryId": "string","schema": {"id": "string","name": "string"},"webURL": "string","apiURL": "string"},"eventType": "v2.entity.registered"}}
v2.entry.created
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.entry.created","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"entry": {"archiveRecord": {"reason": "string"},"authors": [{"handle": "string","id": "string","name": "string"}],"createdAt": "2020-05-04T09:42:00+00:00","creator": {"handle": "string","id": "string","name": "string"},"customFields": {},"days": [{"date": "string","notes": [{"checked": true,"externalFileId": "string","indentation": 42,"links": [{"id": "string","type": "link","webURL": "string"}],"table": {"columnLabels": ["string"],"name": "string","rows": [{"cells": [{"link": {"id": "string","type": "link","webURL": "string"},"text": "string"}]}]},"text": "string","type": "text"}]}],"displayId": "string","fields": {},"folderId": "string","id": "string","modifiedAt": "string","name": "string","reviewRecord": {},"schema": {"id": "string","name": "string"},"webURL": "string","apiURL": "string"},"eventType": "v2.entry.created"}}
v2.entry.updated.fields
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.entry.updated.fields","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"entry": {"archiveRecord": {"reason": "string"},"authors": [{"handle": "string","id": "string","name": "string"}],"createdAt": "2020-05-04T09:42:00+00:00","creator": {"handle": "string","id": "string","name": "string"},"customFields": {},"days": [{"date": "string","notes": [{"checked": true,"externalFileId": "string","indentation": 42,"links": [{"id": "string","type": "link","webURL": "string"}],"table": {"columnLabels": ["string"],"name": "string","rows": [{"cells": [{"link": {"id": "string","type": "link","webURL": "string"},"text": "string"}]}]},"text": "string","type": "text"}]}],"displayId": "string","fields": {},"folderId": "string","id": "string","modifiedAt": "string","name": "string","reviewRecord": {},"schema": {"id": "string","name": "string"},"webURL": "string","apiURL": "string"},"eventType": "v2.entry.updated.fields"}}
v2.entry.updated.reviewRecord
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.entry.updated.reviewRecord","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"entry": {"archiveRecord": {"reason": "string"},"authors": [{"handle": "string","id": "string","name": "string"}],"createdAt": "2020-05-04T09:42:00+00:00","creator": {"handle": "string","id": "string","name": "string"},"customFields": {},"days": [{"date": "string","notes": [{"checked": true,"externalFileId": "string","indentation": 42,"links": [{"id": "string","type": "link","webURL": "string"}],"table": {"columnLabels": ["string"],"name": "string","rows": [{"cells": [{"link": {"id": "string","type": "link","webURL": "string"},"text": "string"}]}]},"text": "string","type": "text"}]}],"displayId": "string","fields": {},"folderId": "string","id": "string","modifiedAt": "string","name": "string","reviewRecord": {},"schema": {"id": "string","name": "string"},"webURL": "string","apiURL": "string"},"eventType": "v2.entry.updated.reviewRecord}}
v2.request.created
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.request.created","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"eventType": "v2.request.created","request": {"assignees": ["string"],"createdAt": "2017-04-23 01:30:50 +0000","creator": {"handle": "string","id": "string","name": "string"},"displayId": "string","fields": {},"id": "string","projectId": "string","requestStatus": "string","requestor": {"handle": "string","id": "string","name": "string"},"scheduledOn": "2019-09-12","schema": {"id": "string","name": "string"},"webURL": "string","apiURL": "string"}}}
v2.request.updated.fields
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.request.updated.fields","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"eventType": "v2.request.updated.fields","request": {"assignees": ["string"],"createdAt": "2017-04-23 01:30:50 +0000","creator": {"handle": "string","id": "string","name": "string"},"displayId": "string","fields": {},"id": "string","projectId": "string","requestStatus": "string","requestor": {"handle": "string","id": "string","name": "string"},"scheduledOn": "2019-09-12","schema": {"id": "string","name": "string"},"webURL": "string","apiURL": "string"}}}
v2.request.updated.status
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.request.updated.status","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"eventType": "v2.request.updated.status"request": {"assignees": ["string"],"createdAt": "2017-04-23 01:30:50 +0000","creator": {"handle": "string","id": "string","name": "string"},"displayId": "string","fields": {},"id": "string","projectId": "string","requestStatus": "string","requestor": {"handle": "string","id": "string","name": "string"},"scheduledOn": "2019-09-12","schema": {"id": "string","name": "string"},"webURL": "string","apiURL": "string"}}}
v2.workflowTaskGroup.created
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowTaskGroup.created","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string","creationOrigin": {"application": "string","originId": "string","originType": "string"},"creator": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"executionType": "DIRECT","outputs": [{"displayId": "string","id": "wfout_5cJLQKVF"}],"responsibleTeam": {"handle": "elion_team","id": "team_5cjIguqc","name": "Elion's Team"},"tasks": [{"displayId": "string","id": "wftask_OnnsW08k"}],"watchers": [{"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"}],"webURL": "string"},"eventType": "v2.workflowTaskGroup.created"}}
v2.workflowTaskGroup.updated.watchers
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowTaskGroup.updated.watchers","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string","creationOrigin": {"application": "string","originId": "string","originType": "string"},"creator": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"executionType": "DIRECT","outputs": [{"displayId": "string","id": "wfout_5cJLQKVF"}],"responsibleTeam": {"handle": "elion_team","id": "team_5cjIguqc","name": "Elion's Team"},"tasks": [{"displayId": "string","id": "wftask_OnnsW08k"}],"watchers": [{"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"}],"webURL": "string"},"eventType": "v2.workflowTaskGroup.updated.watchers"}}
v2.workflowTask.created
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowTask.created","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"workflowTask": {"displayId": "string","id": "wftask_OnnsW08k","assignee": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"creationOrigin": {"application": "string","originId": "string","originType": "string"},"creator": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"executionOrigin": {"entryId": "etr_30ad79","type": "API"},"executionType": "DIRECT","fields": {},"outputs": [{"displayId": "string","id": "wfout_5cJLQKVF"}],"cloneFrom": {"displayId": "string","id": "wftask_OnnsW08k"},"scheduledOn": "2020-08-01","status": {"displayName": "Pending","id": "prsts_wQzUCsW0","statusType": "PENDING"},"webURL": "string","workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string"}},"eventType": "v2.workflowTask.created"}}
v2.workflowTask.updated.assignee
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowTask.updated.assignee","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"workflowTask": {"displayId": "string","id": "wftask_OnnsW08k","assignee": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"creationOrigin": {"application": "string","originId": "string","originType": "string"},"creator": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"executionOrigin": {"entryId": "etr_30ad79","type": "API"},"executionType": "DIRECT","fields": {},"outputs": [{"displayId": "string","id": "wfout_5cJLQKVF"}],"cloneFrom": {"displayId": "string","id": "wftask_OnnsW08k"},"scheduledOn": "2020-08-01","status": {"displayName": "Pending","id": "prsts_wQzUCsW0","statusType": "PENDING"},"webURL": "string","workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string"}},"eventType": "v2.workflowTask.updated.assignee"}}
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowTask.updated.assignee","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"workflowTask": {"displayId": "string","id": "wftask_OnnsW08k","assignee": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"creationOrigin": {"application": "string","originId": "string","originType": "string"},"creator": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"executionOrigin": {"entryId": "etr_30ad79","type": "API"},"executionType": "DIRECT","fields": {},"outputs": [{"displayId": "string","id": "wfout_5cJLQKVF"}],"relationshipsFrom": [{"fromTask": {"displayId": "string","id": "wftask_OnnsW08k"},"id": "prstrel_hi4Nncr4","relationshipType": "BASE_OF","toTask": {"displayId": "string","id": "wftask_OnnsW08k"}}],"relationshipsTo": [{"fromTask": {"displayId": "string","id": "wftask_OnnsW08k"},"id": "prstrel_hi4Nncr4","relationshipType": "BASE_OF","toTask": {"displayId": "string","id": "wftask_OnnsW08k"}}],"scheduledOn": "2020-08-01","status": {"displayName": "Pending","id": "prsts_wQzUCsW0","statusType": "PENDING"},"webURL": "string","workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string"}},"eventType": "v2.workflowTask.updated.assignee"}}
v2.workflowTask.updated.scheduledOn
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowTask.updated.scheduledOn","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"workflowTask": {"displayId": "string","id": "wftask_OnnsW08k","assignee": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"creationOrigin": {"application": "string","originId": "string","originType": "string"},"creator": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"executionOrigin": {"entryId": "etr_30ad79","type": "API"},"executionType": "DIRECT","fields": {},"outputs": [{"displayId": "string","id": "wfout_5cJLQKVF"}],"cloneFrom": {"displayId": "string","id": "wftask_OnnsW08k"},"scheduledOn": "2020-08-01","status": {"displayName": "Pending","id": "prsts_wQzUCsW0","statusType": "PENDING"},"webURL": "string","workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string"}},"eventType": "v2.workflowTask.updated.scheduledOn"}}
v2.workflowTask.updated.status
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowTask.updated.status","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"workflowTask": {"displayId": "string","id": "wftask_OnnsW08k","assignee": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"creationOrigin": {"application": "string","originId": "string","originType": "string"},"creator": {"handle": "lpasteur","id": "ent_a0SApq3z","name": "Louis Pasteur"},"executionOrigin": {"entryId": "etr_30ad79","type": "API"},"executionType": "DIRECT","fields": {},"outputs": [{"displayId": "string","id": "wfout_5cJLQKVF"}],"cloneFrom": {"displayId": "string","id": "wftask_OnnsW08k"},"scheduledOn": "2020-08-01","status": {"displayName": "Pending","id": "prsts_wQzUCsW0","statusType": "PENDING"},"webURL": "string","workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string"}},"eventType": "v2.workflowTask.updated.status"}}
v2.workflowTask.updated.fields
{"createdAt": "2022-05-18T20:32:40.374866+00:00","deprecated": false,"eventType": "v2.workflowTask.updated.fields","excludedProperties": [],"id": "evt_PWsYau4gizUV","schema": {"id": "prstsch_WB6agl5W","name": "[QA][FLOWCHART] Schema A - Everything has an output"},"updates": ["fields.Bioentity field (multi)"],"workflowTask": {"archiveRecord": null,"assignee": null,"clonedFrom": null,"creationOrigin": {"application": "PROCESSES","originId": "prs_pbvxsY4Q","originModalUuid": null,"originType": "PROCESS"},"creator": {"handle": "sameer.pillai","id": "ent_QN6wtROQ","name": "Sameer Pillai"},"displayId": "QA_FA32-T2","executionOrigin": null,"executionType": "FLOWCHART","fields": {"Bioentity field (multi)": {"displayValue": "SameerEnt1, SameerEnt3","isMulti": true,"textValue": "SameerEnt1, SameerEnt3","type": "entity_link","value": ["bfi_h0TdM5L1","bfi_HdqMyBcY"]},"Bioentity field (single)": {"displayValue": "SameerEnt1","isMulti": false,"textValue": "SameerEnt1","type": "entity_link","value": "bfi_h0TdM5L1"},"Text field": {"displayValue": null,"isMulti": false,"textValue": null,"type": "text","value": null}},"id": "wftask_LJUyvXqt","scheduledOn": null,"schema": {"id": "prstsch_WB6agl5W","name": "[QA][FLOWCHART] Schema A - Everything has an output"},"status": {"displayName": "Active","id": "wfts_F5FkG9XO","statusType": "IN_PROGRESS"},"workflowOutputs": [],"workflowTaskGroup": {"displayId": "QA_FA32","id": "prs_pbvxsY4Q","name": "[QA][FLOWCHART] Schema A - Everything has an output 32"}}}
v2.workflowOutput.created
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowOutput.created","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"workflowOutput": {"displayId": "string","id": "wfout_5cJLQKVF","creationOrigin": {"application": "string","originId": "string","originType": "string"},"fields": {},"task": {"displayId": "string","id": "wftask_OnnsW08k"},"webURL": "string","workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string"}}"eventType": "v2.workflowOutput.created"}}
v2.workflowOutput.updated.fields
{"version": "0","id": "XXXX-XXXX-...","detail-type": "v2.workflowOutput.updated.fields","source": "aws.partner...","account": 123123123123,"time": "2015-06-14T22:26:59.673559+00:00","region": "us-west-1","resources": [],"detail": {"createdAt": "2020-05-04T09:42:00+00:00","deprecated": false,"excludedProperties": ["string"],"id": "string","schema": {"id": "string","name": "string"},"updates": ["string"],"workflowOutput": {"displayId": "string","id": "wfout_5cJLQKVF","creationOrigin": {"application": "string","originId": "string","originType": "string"},"fields": {},"task": {"displayId": "string","id": "wftask_OnnsW08k"},"webURL": "string","workflowTaskGroup": {"displayId": "string","id": "prs_giVNQcTL","name": "string"}}"eventType": "v2.workflowOutput.updated.fields"}}