Choose a version:

event

query

Retrieves a single event by ID. Events chronicle activities in your store such as resource creation, updates, or staff comments. The query returns an Event interface of type BasicEvent or CommentEvent.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to EventEvent

•Event

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

Anchor to actionaction •String! non-null: The action that occured.
Anchor to appTitleappTitle •String: The name of the app that created the event.
Anchor to attributeToAppattributeToApp •Boolean! non-null: Whether the event was created by an app.
Anchor to attributeToUserattributeToUser •Boolean! non-null: Whether the event was caused by an admin user.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time when the event was created.
Anchor to criticalAlertcriticalAlert •Boolean! non-null: Whether the event is critical.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to messagemessage •FormattedString! non-null: Human readable text that describes the event.

Was this section helpful?

Examples

Retrieve the first basic-event

Description

Retrieve an event by its id.

Query

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-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 } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Ruby

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)

Node.js

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
        }
      }
    }
  }`,
});

Response

{
  "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"
    }
  }
}

Retrieves a single event

Query

query EventShow($id: ID!) {
  event(id: $id) {
    id
    action
    createdAt
    message
    ... on BasicEvent {
      arguments
      subjectId
      subjectType
      additionalContent
    }
  }
}

Variables

{
  "id": "gid://shopify/BasicEvent/267851118"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query EventShow($id: ID!) { event(id: $id) { id action createdAt message ... on BasicEvent { arguments subjectId subjectType additionalContent } } }",
 "variables": {
    "id": "gid://shopify/BasicEvent/267851118"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query EventShow($id: ID!) {
    event(id: $id) {
      id
      action
      createdAt
      message
      ... on BasicEvent {
        arguments
        subjectId
        subjectType
        additionalContent
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/BasicEvent/267851118"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 EventShow($id: ID!) {
    event(id: $id) {
      id
      action
      createdAt
      message
      ... on BasicEvent {
        arguments
        subjectId
        subjectType
        additionalContent
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/BasicEvent/267851118"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query EventShow($id: ID!) {
      event(id: $id) {
        id
        action
        createdAt
        message
        ... on BasicEvent {
          arguments
          subjectId
          subjectType
          additionalContent
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/BasicEvent/267851118"
    },
  },
});

Response

{
  "event": {
    "id": "gid://shopify/BasicEvent/267851118",
    "action": "unpublished",
    "createdAt": "2006-06-09T12:00:00Z",
    "message": "",
    "arguments": [],
    "subjectId": "gid://shopify/Product/630255015",
    "subjectType": "PRODUCT",
    "additionalContent": "null"
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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 json = await response.json();

return json.data;

}

GQL

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-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 } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Node.js

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
        }
      }
    }
  }`,
});

Ruby

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"

}