Admin API/Common objects/Mutations

webhookSubscriptionCreate

mutation

Subscribes the app to a topic. Deliveries are async, retried for 48 h; the body is the resource as it is when sent.

Returns WebhookSubscriptionCreatePayload!

mutation WebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {
  webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) {
    webhookSubscription {
      id
      createdAt
      callbackUrl
      format
      topic
    }
    userErrors {
      code
      message
      field
    }
  }
}

# Variables
{
  "topic": "ORDERS_CANCELLED",
  "webhookSubscription": {
    "callbackUrl": ""
  }
}

Arguments

topicWebhookSubscriptionTopic!required
webhookSubscriptionWebhookSubscriptionInput!required

Payload

userErrors[UserError!]!required
webhookSubscriptionWebhookSubscription

mutation WebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) { webhookSubscriptionCreate(topic: $topic, webhookSubscription: $webhookSubscription) { webhookSubscription { id createdAt callbackUrl format topic } userErrors { code message field } } } # Variables { "topic": "ORDERS_CANCELLED", "webhookSubscription": { "callbackUrl": "" } }