Choose a version:

event

query

Get a single event by its id.

Arguments

Anchor to idid • ID!required: The ID of the event.

Was this section helpful?

Anchor to Possible returnsPossible returns

Event

•

Event

Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the addition of a product.

action• String! non-null: The action that occured.
appTitle• String: The name of the app that created the event.
attributeToApp• Boolean! non-null: Whether the event was created by an app.
attributeToUser• Boolean! non-null: Whether the event was caused by an admin user.
createdAt• DateTime! non-null: The date and time when the event was created.
criticalAlert• Boolean! non-null: Whether the event is critical.
id• ID! non-null: A globally-unique ID.
message• FormattedString! non-null: Human readable text that describes the event.

Was this section helpful?

Retrieve the first basic-event
Retrieves a single event

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

event(id: "gid://shopify/BasicEvent/422690323") {

message

... on BasicEvent {

action

subjectType

subject {

__typename

}

}`,

);

const data = await response.json();

query {
  event(id: "gid://shopify/BasicEvent/422690323") {
    id
    message
    ... on BasicEvent {
      action
      subjectType
      subject {
        __typename
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { event(id: \"gid://shopify/BasicEvent/422690323\") { id message ... on BasicEvent { action subjectType subject { __typename } } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    event(id: "gid://shopify/BasicEvent/422690323") {
      id
      message
      ... on BasicEvent {
        action
        subjectType
        subject {
          __typename
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    event(id: "gid://shopify/BasicEvent/422690323") {
      id
      message
      ... on BasicEvent {
        action
        subjectType
        subject {
          __typename
        }
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    event(id: "gid://shopify/BasicEvent/422690323") {
      id
      message
      ... on BasicEvent {
        action
        subjectType
        subject {
          __typename
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"event": {

"id": "gid://shopify/BasicEvent/422690323",

"message": "bob bobsen included a product on Online Store: <a href=\"https://admin.myshopify.io/store/snowdevil/admin/products/440089423\">IPod Nano - 8GB</a>.",

"action": "published",

"subjectType": "PRODUCT",

"subject": {

"__typename": "Product"

}