# eventBridgeWebhookSubscriptionCreate - admin-graphql - MUTATION Version: 2025-01 ## Description Creates a new Amazon EventBridge webhook subscription. Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). ### Access Scopes ## Arguments * [topic](/docs/api/admin-graphql/2025-01/enums/WebhookSubscriptionTopic): WebhookSubscriptionTopic! - The type of event that triggers the webhook. * [webhookSubscription](/docs/api/admin-graphql/2025-01/input-objects/EventBridgeWebhookSubscriptionInput): EventBridgeWebhookSubscriptionInput! - Specifies the input fields for an EventBridge webhook subscription. ## Returns * [userErrors](/docs/api/admin-graphql/2025-01/objects/UserError): UserError! The list of errors that occurred from executing the mutation. * [webhookSubscription](/docs/api/admin-graphql/2025-01/objects/WebhookSubscription): WebhookSubscription The webhook subscription that was created. ## Examples ### Create a METAOBJECTS_CREATE EventBridge webhook subscription for lookbook metaobjects Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) { eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic filter format endpoint { __typename ... on WebhookEventBridgeEndpoint { arn } } } userErrors { field message } } }\",\n \"variables\": {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/1830279/test-event-source\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/1830279/test-event-source\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/1830279/test-event-source\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/1830279/test-event-source\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "topic": "METAOBJECTS_CREATE", "webhookSubscription": { "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/1830279/test-event-source", "format": "JSON", "filter": "type:lookbook" } } #### Graphql Response { "data": { "eventBridgeWebhookSubscriptionCreate": { "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/8589934706", "topic": "METAOBJECTS_CREATE", "filter": "type:lookbook", "format": "JSON", "endpoint": { "__typename": "WebhookEventBridgeEndpoint", "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/1830279/test-event-source" } }, "userErrors": [] } } } ### Create an Amazon EventBridge webhook subscription for ORDERS_CREATE events Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) { eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format endpoint { __typename ... on WebhookEventBridgeEndpoint { arn } } } userErrors { field message } } }\",\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "topic": "ORDERS_CREATE", "webhookSubscription": { "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source", "format": "JSON" } } #### Graphql Response { "data": { "eventBridgeWebhookSubscriptionCreate": { "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/8589934709", "topic": "ORDERS_CREATE", "format": "JSON", "endpoint": { "__typename": "WebhookEventBridgeEndpoint", "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source" } }, "userErrors": [] } } } ### Create an ORDERS_CREATE EventBridge webhook subscription thatincludes metafields during serialization Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) { eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format metafieldNamespaces endpoint { __typename ... on WebhookEventBridgeEndpoint { arn } } } userErrors { field message } } }\",\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ],\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ],\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"ORDERS_CREATE\",\n \"metafieldNamespaces\": [\"MY_NAMESPACE\", \"ANOTHER_NAMESPACE\"],\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"ORDERS_CREATE\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ],\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "topic": "ORDERS_CREATE", "metafieldNamespaces": [ "MY_NAMESPACE", "ANOTHER_NAMESPACE" ], "webhookSubscription": { "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source", "format": "JSON" } } #### Graphql Response { "data": { "eventBridgeWebhookSubscriptionCreate": { "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/8589934704", "topic": "ORDERS_CREATE", "format": "JSON", "metafieldNamespaces": [], "endpoint": { "__typename": "WebhookEventBridgeEndpoint", "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source" } }, "userErrors": [] } } } ### Create an ORDERS_CREATE EventBridge webhook subscription with fewer resource fields Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) { eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format includeFields endpoint { __typename ... on WebhookEventBridgeEndpoint { arn } } } userErrors { field message } } }\",\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ],\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ],\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"ORDERS_CREATE\",\n \"includeFields\": [\"id\", \"note\"],\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"ORDERS_CREATE\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ],\n \"webhookSubscription\": {\n \"arn\": \"arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source\",\n \"format\": \"JSON\"\n }\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation eventBridgeWebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {\n eventBridgeWebhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookEventBridgeEndpoint {\n arn\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "topic": "ORDERS_CREATE", "includeFields": [ "id", "note" ], "webhookSubscription": { "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source", "format": "JSON" } } #### Graphql Response { "data": { "eventBridgeWebhookSubscriptionCreate": { "webhookSubscription": { "id": "gid://shopify/WebhookSubscription/8589934702", "topic": "ORDERS_CREATE", "format": "JSON", "includeFields": [], "endpoint": { "__typename": "WebhookEventBridgeEndpoint", "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/166357/test-event-source" } }, "userErrors": [] } } }