webhook_create

Arguments

ArgumentTypeRequiredDefaultDescription
dataCreateWebhookInput!Yes

Return Type

CreateWebhookOutput

Mutation

mutation webhook_create(
  $data: CreateWebhookInput!
) {
  webhook_create(
    data: $data
  ) {
    request_id
    complexity
    webhook {
      ...WebhookFragment
    }
  }
}

Variables

{
  "data": {
    "customer_account_id": "QWNjb3VudDoxMjM0",
    "name": "Order Shipped Webhook",
    "url": "https://example.com/resource",
    "enabled": true,
    "shop_name": "Order Shipped Webhook"
  }
}

Response

{
  "data": {
    "webhook_create": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "webhook": {name: "Order Shipped Webhook", url: "https://example.com/webhooks/shiphero"}
    }
  }
}