Shopify metafields webhook events

Shopify sends 6 metafields events, including metafield_definitions/create, metafield_definitions/delete and metafield_definitions/update.

Every event here can also reach agents as an MCP event through Hookdeck: MCP events →

metafield_definitions/create

documented from Shopify docs (example)

New metafield definition created

Identified by x-shopify-topic header Resource metafields

shopify-metafield-definitions-create.json
{
  "id": null,
  "shop_id": 548380009,
  "namespace": "example-type",
  "key": "example-key",
  "name": "Example Field",
  "description": null,
  "owner_type": "Customer",
  "deleting": false
}

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

metafield_definitions/delete

documented from Shopify docs (example)

Metafield definition is deleted

Identified by x-shopify-topic header Resource metafields

shopify-metafield-definitions-delete.json
{
  "id": "gid://shopify/MetafieldDefinition/1",
  "type": "ShopifyMetafields::Types::SingleLineTextFieldType",
  "created_by_app_id": null
}

Key fields

Field Type Example
id string gid://shopify/MetafieldDefinition/1
type string ShopifyMetafields::Types::SingleLineTextFieldType

Full schema: 3 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

metafield_definitions/update

documented from Shopify docs (example)

Metafield definition changes

Identified by x-shopify-topic header Resource metafields

shopify-metafield-definitions-update.json
{
  "id": null,
  "shop_id": 548380009,
  "namespace": "example-type",
  "key": "example-key",
  "name": "Example Field",
  "description": null,
  "owner_type": "Customer",
  "deleting": false
}

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

metaobjects/create

documented from Shopify docs (example)

New metaobject created

Identified by x-shopify-topic header Resource metafields

shopify-metaobjects-create.json
{
  "type": "example-type",
  "handle": "example-metaobject",
  "created_at": "1975-10-31T00:55:12-05:00",
  "updated_at": "1985-07-13T01:55:12-04:00",
  "display_name": "Example Metaobject",
  "id": "gid://shopify/Metaobject/123",
  "definition_id": "gid://shopify/MetaobjectDefinition/222",
  "fields": { … },
  "created_by_staff_id": "gid://shopify/StaffMember/444",
  "created_by_app_id": "gid://shopify/ApiClient/333",
  "capabilities": { … }
}

Key fields

Field Type Example
id string gid://shopify/Metaobject/123
type string example-type
created_at string 1975-10-31T00:55:12-05:00

Full schema: 14 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

metaobjects/delete

documented from Shopify docs (example)

Metaobject is deleted

Identified by x-shopify-topic header Resource metafields

shopify-metaobjects-delete.json
{
  "id": "gid://shopify/Metaobject/123",
  "type": "example-type",
  "handle": "example-metaobject",
  "created_by_app_id": "gid://shopify/ApiClient/333"
}

Key fields

Field Type Example
id string gid://shopify/Metaobject/123
type string example-type

Full schema: 4 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

metaobjects/update

documented from Shopify docs (example)

Metaobject details change

Identified by x-shopify-topic header Resource metafields

shopify-metaobjects-update.json
{
  "type": "example-type",
  "handle": "example-metaobject",
  "created_at": "1975-10-31T00:55:12-05:00",
  "updated_at": "1985-07-13T01:55:12-04:00",
  "display_name": "Example Metaobject",
  "id": "gid://shopify/Metaobject/123",
  "definition_id": "gid://shopify/MetaobjectDefinition/222",
  "fields": { … },
  "created_by_staff_id": "gid://shopify/StaffMember/444",
  "created_by_app_id": "gid://shopify/ApiClient/333",
  "capabilities": { … }
}

Key fields

Field Type Example
id string gid://shopify/Metaobject/123
type string example-type
created_at string 1975-10-31T00:55:12-05:00

Full schema: 14 fields.

From Shopify docs

  • Content type application/json

Send example to Inspect → View as JSON

Route Shopify events by type.

Event Gateway receives every Shopify delivery and filters and routes it by event type, so each service gets only the events it handles.

Not affiliated with Shopify. Facts are compiled from public sources and linked inline.