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

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.

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/2025-04/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 } } } }"
}'

Remix

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();

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/2025-04/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"
  }
}'

Remix

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

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

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-04/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"

}