Events Reference

Benchling delivers events two ways, and they do not share the same payload shape, permissions model, or subscription path. Use this page when you need EventBridge payload details, supported event types, or the differences between the two delivery models. For the HTTP message contract Benchling sends to a webhook receiver, see Getting Started with Webhooks and Webhook Security. Once a delivery arrives and you need the latest resource state, use the REST API Reference.

JSON example pages

• V2 EventBridge JSON Examples
• V2 Beta EventBridge JSON Examples
• V2 Alpha EventBridge JSON Examples

Delivery model differences

EventBridge payload reference

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 V2 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.

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 instructions in the Getting Started Guide and add that event type from the dropdown.

V2 Events Reference

V2 Beta Events Reference

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

V2 Alpha Events Reference

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