webhookSubscription创建-webhookSubscriptionCreate mutation

创建一个新的webhook订阅。


在本页面


互动范例

这是一个示例变异查询。

突变webhookSubscriptionCreate $ topic WebhookSubscriptionTopic $ webhookSubscription WebhookSubscriptionInput !){ webhookSubscriptionCreate 主题$ topic webhookSubscription $ webhookSubscription {
  1. <font style="color:#1F61A0;">userErrors </font><font style="color:#555555;">{</font>
  2. <font style="color:#1F61A0;">场地</font>
  3. <font style="color:#1F61A0;">信息</font>
  4. <font style="color:#555555;">}</font>
  5. <font style="color:#1F61A0;">webhookSubscription </font><font style="color:#555555;">{</font>
  6. <font style="color:#1F61A0;">ID</font>
  7. <font style="color:#555555;">}</font>
} } { “ topic” “占位符” “ webhookSubscription” {} }


参数

参数 描述
topic
() [WebhookSubscriptionTopic!](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptiontopic)

必需的
触发Webhook的事件类型。
webhookSubscription
() [WebhookSubscriptionInput!](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptioninput)

必需的
指定Webhook订阅的输入字段。


WebhookSubscriptionInput字段

  • callbackUrl([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01)
    事件发生时,webhook订阅应在其中发送POST请求的URL。
  • 格式([WebhookSubscriptionFormat](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscriptionformat)
    Webhook订阅应发送数据的格式。
  • includeFields([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)
    Webhook订阅中将包含的字段列表。
  • metafieldNamespaces([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)
    webhook订阅中应包含的任何元字段的名称空间列表。


返回字段

  • userErrors([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror)
    执行突变时发生的错误列表。
  • webhook订阅([WebhookSubscription](https://shopify.dev/docs/admin-api/graphql/reference/events/webhooksubscription)
    已创建的Webhook订阅。