Warehouse & API GuidesRecipesAPI ReferenceSDK ReferenceWebhooks ReferenceChangelog
Warehouse & API Guides

Events Reference

Suggest Edits

Current Types of Events

Current events are linked to creation, registration, completion, and update of a subset of objects within Benchling. If you have additional Events that would be highly impactful, please reach out to Benchling support to let us know!

Event Payload

All events have a standard JSON payload with the following structure:

{
  "version": "0", # Unused
  "id": "XXXX-XXXX-...", # Unique AWS ID 
  "detail-type": "v2.request.created", # <version>.<resource_type>.<action>
  "source": "aws.partner...", # Event Subscription Name
  "account": 123123123123, # AWS Destination Account ID
  "time": "2015-06-14T22:26:59.673559+00:00", # Isoformat UTC when the event is created
  "region": "us-west-1", # AWS region
  "resources": [], # Unused
  "detail": {
  	"createdAt": "2015-06-14T22:26:59.673559+00:00", # Isoformat UTC when the event is created, same as "time" above
    "deprecated": false, # True if an event has been deprecated. It is best practice to alert on this to know when to migrate. 
    "entry": {...}, # This will vary, depending on resource type
 	  "eventType": "v2.request.created", # <version>.<resource_type>.<action>, same as "detail-type" above
	  "excludedProperties": ["dropped_key1","dropped_key2"] # Empty unless properties were excluded for being too large
    "id": "evt_XXX...", # Unique Benchling Event ID
    "schema": {
      "name": "...", # Name of the schema event is related to
      "id": "..." # id of the schema event is related to
    } 
    "updates": ["fields.cool"] # Fields that changed. Only present on update events
  },
}

In the above, the "entry": {...} field will vary based on the resource that's being sent. See the "Resource Name" column in the Events Reference section for the field name for each event and the "API Get Endpoint Link" column for a link to the API reference documentation that outlines the content.

🚧

Outdated Event Payloads

Data in the event payload should not be treated as up-to-date. Events can be delivered late or out-of-order, so it’s best practice to look up the corresponding objects with the Benchling API if you need the latest information.

Oversized Events

Due to the fact that events on EventBridge have a maximum size of 256kb, some fields will be dropped when the event is oversized. The properties that were dropped are included in the excludedProperties field.

If one of those fields is critical for you to retrieve, the resource object (entry: {...} in the above example) has a apiURL field that contains the URL to retrieve the full resource from the API.

Event Subscription

To subscribe to any of the following events, you'll need to follow the instruction in the Getting Started Guide and add that event type from the dropdown.

V2 Events Reference

Event NameEvent DescriptionResource NameAPI Get Endpoint Link
v2.assayRun.createdFired when a run is createdassayRunAssay Run
v2.assayRun.updated.fieldsFired when a run's fields are updatedassayRunAssay Run
v2.entity.registeredFired when an entity is registeredentity[Entity Resource] (https://docs.benchling.com/docs/events-reference#v2entityregistered)
v2.entry.createdFired when a notebook entry is created. Only applicable for entries that are not a part of a Legacy Workflow.entryEntry Resource
v2.entry.updated.fieldsFired when a notebook entry's schema or fields are updated. Only applicable for entries that are not a part of a Legacy Workflow.entryEntry
v2.entry.updated.reviewRecordFired when a notebook entry's reviewRecord is updated. Only applicable for entries that are not a part of a Legacy Workflow.entryEntry
v2.request.createdFired when a request is createdrequestRequest
v2.request.updated.fieldsFired when a request's fields are updatedrequestRequest
v2.request.updated.statusFired when a request's status is updatedrequestRequest
v2.workflowTaskGroup.createdFired when a workflow task group is createdworkflowTaskGroupWorkflow Task Group
v2.workflowTaskGroup.updated.watchersFired when a workflow task group's watchers are updatedworkflowTaskGroupWorkflow Task Group
v2.workflowTask.createdFired when a workflow task is createdworkflowTaskWorkflow Task
v2.workflowTask.updated.assigneeFired when a workflow task's assignee is updatedworkflowTaskWorkflow Task
v2.workflowTask.updated.scheduledOnFired when a workflow task's scheduledOn is updatedworkflowTaskWorkflow Task
v2.workflowTask.updated.statusFired when a workflow task's status is updatedworkflowTaskWorkflow Task
v2.workflowTask.updated.fieldsFired when a workflow task's fields are updatedworkflowTaskWorkflow Task
v2.workflowOutput.createdFired when a workflow output is createdworkflowOutputWorkflow Output
v2.workflowOutput.updated.fieldsFired when a workflow output's fields are updatedworkflowOutputWorkflow Output

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.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",
      "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"
  }
}

V2 Beta Events Reference

🚧

Using Beta Events

Events under v2-beta are subject to more frequent breaking changes. We will notify developers prior to making breaking changes, but we recommend setting up monitoring to account for them if you are using them in production. Overall, we generally recommend only using v2.* events in production whenever possible.

See our Stability documentation for more information on Beta and what it means!

Beta events are not listed by default. Please contact Benchling support to access these events.

Event NameEvent DescriptionResource NameAPI Get Endpoint Link
v2-beta.automation InputGenerator.completedFired when a file has been generated by an automation input generatorautomation InputGeneratorAutomation Input Generator
v2-beta.automation OutputProcessor.completedFired when a file has been processed by an automation output processorautomation OutputProcessorAutomation Output Processor
v2-beta.automation OutputProcessor.uploadedFired when a file has been uploaded to an automation output processorautomation OutputProcessorAutomation Output Processor
v2-beta.automation FileTransform.updated.statusFired when a file transform undergoes a status changeTransformTransform

JSON Examples

JSON structure of all V2 Beta events.

v2-beta.automationInputGenerator.completed

{
  "version": "0",
  "id": "XXXX-XXXX-...", 
  "detail-type": "v2-beta.automationInputGenerator.completed",
  "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"
    },
    "automationInputGenerator": {
      "assayRunId": "string",
      "automationFileConfig": {
        "name": "string"
      },
      "file": {
        "id": "string",
        "mimeType": "string",
        "name": "string",
        "type": "string",
        "uploadStatus": "string"
      },
      "id": "string",
      "status": "string"
    },
    "eventType": "v2-beta.automationInputGenerator.completed"
  }
}

v2-beta.automationOutputProcessor.completed

{
  "version": "0",
  "id": "XXXX-XXXX-...", 
  "detail-type": "v2-beta.automationOutputProcessor.completed",
  "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"
    },
    "automationOutputProcessor": {
      "assayRunId": "string",
      "automationFileConfig": {
        "name": "string"
      },
      "file": {
        "id": "string",
        "mimeType": "string",
        "name": "string",
        "type": "string",
        "uploadStatus": "string"
      },
      "id": "string",
      "status": "string"
    },
    "eventType": "v2-beta.automationOutputProcessor.completed"
  }
}

v2-beta.automationOutputProcessor.uploaded

{
  "version": "0",
  "id": "XXXX-XXXX-...", 
  "detail-type": "v2-beta.automationOutputProcessor.uploaded",
  "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"
    },
    "automationOutputProcessor": {
      "assayRunId": "string",
      "automationFileConfig": {
        "name": "string"
      },
      "file": {
        "id": "string",
        "mimeType": "string",
        "name": "string",
        "type": "string",
        "uploadStatus": "string"
      },
      "id": "string",
      "status": "string"
    },
    "eventType": "v2-beta.automationOutputProcessor.uploaded"
  }
}

v2-beta.automationFileTransform.updated.status

{
    "version": "0",
    "id": "XXXX-XXXX-...",
    "detail-type": "v2-beta.automationFileTransform.updated.status",
    "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-beta.automationFileTransform.updated.status"
    }
}

V2 Alpha Events Reference

❗️

Using Alpha Events

Events under v2-alpha are in active development and can change or be removed entirely without notice. They should only be used for testing purposes and we encourage those that do use them to reach out with feedback!

See our Stability documentation for more information on Alpha and what it means!

Alpha events are not listed by default. Please contact Benchling support to access these events.

Event NameEvent DescriptionResource NameAPI Get Endpoint Link
v2-alpha.stageEntry.createdFired when a legacy workflow stage entry is createdstageEntryStage Entry
v2-alpha.stageEntry.updated.fieldsFired when a legacy workflow stage entry's schema or fields are updatedstageEntryStage Entry
v2-alpha.stageEntry.updated.reviewRecordFired when a legacy workflow stage entry's review record has transitioned statusstageEntryStage Entry

v2-alpha.stageEntry.created

{
  "version": "0",
  "id": "XXXX-XXXX-...", 
  "detail-type": "v2-alpha.stageEntry.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"
    },
    "stageEntry": {
      "apiURL": "https://benchling.com/api/v2-alpha/stage-entries/stgentr_1HEcejZq",
      "authors": [
        {
          "handle": "lpasteur",
          "id": "ent_a0SApq3z",
          "name": "Louis Pasteur"
        }
      ],
      "createdAt": "2021-11-16T21:43:14.880Z",
      "creator": {
        "handle": "lpasteur",
        "id": "ent_a0SApq3z",
        "name": "Louis Pasteur"
      },
      "customFields": {
        "Legacy ID": {
          "value": "STR100"
        }
      },
      "displayId": "string",
      "fields": {},
      "folderId": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "reviewRecord": {},
      "schema": {
        "id": "string",
        "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
        "name": "string"
      },
      "webURL": "string",
      "workflowId": "wfw_7COQmok7",
      "workflowStageId": "wfwstg_EZuryAiW"
    },
    "eventType": "v2-alpha.stageEntry.created"
  }
}

v2-alpha.stageEntry.updated.fields

{
  "version": "0",
  "id": "XXXX-XXXX-...", 
  "detail-type": "v2-alpha.stageEntry.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"
    ],
    "stageEntry": {
      "apiURL": "https://benchling.com/api/v2-alpha/stage-entries/stgentr_1HEcejZq",
      "authors": [
        {
          "handle": "lpasteur",
          "id": "ent_a0SApq3z",
          "name": "Louis Pasteur"
        }
      ],
      "createdAt": "2021-11-16T21:43:14.880Z",
      "creator": {
        "handle": "lpasteur",
        "id": "ent_a0SApq3z",
        "name": "Louis Pasteur"
      },
      "customFields": {
        "Legacy ID": {
          "value": "STR100"
        }
      },
      "displayId": "string",
      "fields": {},
      "folderId": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "reviewRecord": {},
      "schema": {
        "id": "string",
        "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
        "name": "string"
      },
      "webURL": "string",
      "workflowId": "wfw_7COQmok7",
      "workflowStageId": "wfwstg_EZuryAiW"
    },
    "eventType": "v2-alpha.stageEntry.updated.fields"
  }
}

v2-alpha.stageEntry.updated.reviewRecord

{
  "version": "0",
  "id": "XXXX-XXXX-...", 
  "detail-type": "v2-alpha.stageEntry.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"
    ],
    "stageEntry": {
      "apiURL": "https://benchling.com/api/v2-alpha/stage-entries/stgentr_1HEcejZq",
      "authors": [
        {
          "handle": "lpasteur",
          "id": "ent_a0SApq3z",
          "name": "Louis Pasteur"
        }
      ],
      "createdAt": "2021-11-16T21:43:14.880Z",
      "creator": {
        "handle": "lpasteur",
        "id": "ent_a0SApq3z",
        "name": "Louis Pasteur"
      },
      "customFields": {
        "Legacy ID": {
          "value": "STR100"
        }
      },
      "displayId": "string",
      "fields": {},
      "folderId": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "reviewRecord": {},
      "schema": {
        "id": "string",
        "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
        "name": "string"
      },
      "webURL": "string",
      "workflowId": "wfw_7COQmok7",
      "workflowStageId": "wfwstg_EZuryAiW"
    },
    "eventType": "v2-alpha.stageEntry.updated.reviewRecord"
  }
}

Updated over 2 years ago