Anchor to section titled 'undefined'webhook
webhook
mutation
2024-07
Creates a new 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.
Anchor to section titled 'Arguments'
Arguments
The type of event that triggers the webhook.
Specifies the input fields for a webhook subscription.
Was this section helpful?
Anchor to section titled 'WebhookSubscriptionCreatePayload returns'
WebhookSubscriptionCreatePayload returns
The list of errors that occurred from executing the mutation.
The webhook subscription that was created.
Was this section helpful?
Code examples for MUTATION: webhookSubscriptionCreate
Query Reference for MUTATION: webhookSubscriptionCreate
"mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n userErrors {\n field\n message\n }\n webhookSubscription {\n # WebhookSubscription fields\n }\n }\n}"Input Reference for MUTATION: webhookSubscriptionCreate
"{\n \"topic\": \"APP_PURCHASES_ONE_TIME_UPDATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.myshopify.com\",\n \"filter\": \"<your-filter>\",\n \"format\": \"JSON\",\n \"includeFields\": [\n \"<your-includeFields>\"\n ],\n \"metafieldNamespaces\": [\n \"<your-metafieldNamespaces>\"\n ]\n }\n}"Schema Reference for MUTATION: webhookSubscriptionCreate
"input WebhookSubscriptionInput {\n callbackUrl: URL\n filter: String\n format: WebhookSubscriptionFormat\n includeFields: [String!]\n metafieldNamespaces: [String!]\n privateMetafieldNamespaces: [String!]\n}\n"Display Examples for MUTATION: webhookSubscriptionCreate
[
{
"example": {
"type_name": "webhooksubscriptioncreate",
"title": "Create a METAOBJECTS_CREATE webhook subscription for lookbook metaobjects",
"query_string": "mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"topic": "METAOBJECTS_CREATE",
"webhookSubscription": {
"callbackUrl": "https://example.org/endpoint",
"format": "JSON",
"filter": "type:lookbook"
}
},
"response": {
"data": {
"webhookSubscriptionCreate": {
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/7768084099",
"topic": "METAOBJECTS_CREATE",
"filter": "type:lookbook",
"format": "JSON",
"endpoint": {
"__typename": "WebhookHttpEndpoint",
"callbackUrl": "https://example.org/endpoint"
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-07",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/webhook_subscription_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) { webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic filter format endpoint { __typename ... on WebhookHttpEndpoint { callbackUrl } } } userErrors { field message } } }\",\n \"variables\": {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n },\n },\n);\n\nconst data = await response.json();\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 webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"METAOBJECTS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"filter\": \"type:lookbook\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n filter\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"topic\" => \"METAOBJECTS_CREATE\",\n \"webhookSubscription\" => [\n \"callbackUrl\" => \"https://example.org/endpoint\",\n \"format\" => \"JSON\",\n \"filter\" => \"type:lookbook\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "topic",
"description": "The type of event that triggers the webhook.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionTopic!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "topic",
"argValue": " \"METAOBJECTS_CREATE\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "webhookSubscription",
"description": "Specifies the input fields for a webhook subscription.",
"type": {
"kind": "INPUT_OBJECT",
"name": "WebhookSubscriptionInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"callbackUrl\":\"https://example.org/endpoint\",\"format\":\"JSON\",\"filter\":\"type:lookbook\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "webhooksubscriptioncreate",
"title": "Create an HTTP webhook subscription for APP_UNINSTALLED events",
"query_string": "mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n}",
"variables": {
"topic": "APP_UNINSTALLED",
"webhookSubscription": {
"callbackUrl": "https://example.org/endpoint",
"format": "JSON"
}
},
"response": {
"data": {
"webhookSubscriptionCreate": {
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/7768084100",
"topic": "APP_UNINSTALLED",
"format": "JSON",
"endpoint": {
"__typename": "WebhookHttpEndpoint",
"callbackUrl": "https://example.org/endpoint"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/webhook_subscription_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) { webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format endpoint { __typename ... on WebhookHttpEndpoint { callbackUrl } } } } }\",\n \"variables\": {\n \"topic\": \"APP_UNINSTALLED\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"APP_UNINSTALLED\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\"\n }\n },\n },\n);\n\nconst data = await response.json();\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 webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"APP_UNINSTALLED\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"APP_UNINSTALLED\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"topic\" => \"APP_UNINSTALLED\",\n \"webhookSubscription\" => [\n \"callbackUrl\" => \"https://example.org/endpoint\",\n \"format\" => \"JSON\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "topic",
"description": "The type of event that triggers the webhook.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionTopic!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "topic",
"argValue": " \"APP_UNINSTALLED\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "webhookSubscription",
"description": "Specifies the input fields for a webhook subscription.",
"type": {
"kind": "INPUT_OBJECT",
"name": "WebhookSubscriptionInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"callbackUrl\":\"https://example.org/endpoint\",\"format\":\"JSON\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "webhooksubscriptioncreate",
"title": "Create an ORDERS_CREATE webhook subscription that includes metafields during serialization",
"query_string": "mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n}",
"variables": {
"topic": "ORDERS_CREATE",
"webhookSubscription": {
"callbackUrl": "https://example.org/endpoint",
"format": "JSON",
"metafieldNamespaces": [
"MY_NAMESPACE",
"ANOTHER_NAMESPACE"
]
}
},
"response": {
"data": {
"webhookSubscriptionCreate": {
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/7768084101",
"topic": "ORDERS_CREATE",
"format": "JSON",
"metafieldNamespaces": [
"MY_NAMESPACE",
"ANOTHER_NAMESPACE"
],
"endpoint": {
"__typename": "WebhookHttpEndpoint",
"callbackUrl": "https://example.org/endpoint"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/webhook_subscription_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) { webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format metafieldNamespaces endpoint { __typename ... on WebhookHttpEndpoint { callbackUrl } } } } }\",\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\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 webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"metafieldNamespaces\": [\"MY_NAMESPACE\", \"ANOTHER_NAMESPACE\"]\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"metafieldNamespaces\": [\n \"MY_NAMESPACE\",\n \"ANOTHER_NAMESPACE\"\n ]\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n metafieldNamespaces\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"topic\" => \"ORDERS_CREATE\",\n \"webhookSubscription\" => [\n \"callbackUrl\" => \"https://example.org/endpoint\",\n \"format\" => \"JSON\",\n \"metafieldNamespaces\" => [\"MY_NAMESPACE\", \"ANOTHER_NAMESPACE\"],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "topic",
"description": "The type of event that triggers the webhook.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionTopic!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "topic",
"argValue": " \"ORDERS_CREATE\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "webhookSubscription",
"description": "Specifies the input fields for a webhook subscription.",
"type": {
"kind": "INPUT_OBJECT",
"name": "WebhookSubscriptionInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"callbackUrl\":\"https://example.org/endpoint\",\"format\":\"JSON\",\"metafieldNamespaces\":[\"MY_NAMESPACE\",\"ANOTHER_NAMESPACE\"]}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "webhooksubscriptioncreate",
"title": "Create an ORDERS_CREATE webhook subscription with fewer resource fields during serialization",
"query_string": "mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n}",
"variables": {
"topic": "ORDERS_CREATE",
"webhookSubscription": {
"callbackUrl": "https://example.org/endpoint",
"format": "JSON",
"includeFields": [
"id",
"note"
]
}
},
"response": {
"data": {
"webhookSubscriptionCreate": {
"webhookSubscription": {
"id": "gid://shopify/WebhookSubscription/7768084102",
"topic": "ORDERS_CREATE",
"format": "JSON",
"includeFields": [
"id",
"note"
],
"endpoint": {
"__typename": "WebhookHttpEndpoint",
"callbackUrl": "https://example.org/endpoint"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/webhook_subscription_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) { webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id topic format includeFields endpoint { __typename ... on WebhookHttpEndpoint { callbackUrl } } } } }\",\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\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 webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"includeFields\": [\"id\", \"note\"]\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"topic\": \"ORDERS_CREATE\",\n \"webhookSubscription\": {\n \"callbackUrl\": \"https://example.org/endpoint\",\n \"format\": \"JSON\",\n \"includeFields\": [\n \"id\",\n \"note\"\n ]\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation webhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {\n webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {\n webhookSubscription {\n id\n topic\n format\n includeFields\n endpoint {\n __typename\n ... on WebhookHttpEndpoint {\n callbackUrl\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"topic\" => \"ORDERS_CREATE\",\n \"webhookSubscription\" => [\n \"callbackUrl\" => \"https://example.org/endpoint\",\n \"format\" => \"JSON\",\n \"includeFields\" => [\"id\", \"note\"],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "topic",
"description": "The type of event that triggers the webhook.",
"type": {
"kind": "ENUM",
"name": "WebhookSubscriptionTopic",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionTopic!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "topic",
"argValue": " \"ORDERS_CREATE\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "webhookSubscription",
"description": "Specifies the input fields for a webhook subscription.",
"type": {
"kind": "INPUT_OBJECT",
"name": "WebhookSubscriptionInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "WebhookSubscriptionInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "webhookSubscription",
"argValue": " {\"callbackUrl\":\"https://example.org/endpoint\",\"format\":\"JSON\",\"includeFields\":[\"id\",\"note\"]}",
"typeKind": "MUTATION"
}
]
}
]