webhooks

Fetch webhooks matching the supplied arguments.

Arguments

Argument	Type	Required	Default	Description
`customer_account_id`	`String`	No		If you are a 3PL you can specify one of your customer's account.
`analyze`	`Boolean`	No		If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

WebhooksQueryResult

Query

query webhooks(
  $customer_account_id: String,
  $analyze: Boolean
) {
  webhooks(
    customer_account_id: $customer_account_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...WebhookConnectionFragment
    
      pageInfo {
        ...PageInfoFragment
      
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      edges {
        ...WebhookEdgeFragment
      
        node {
          ...WebhookFragment
        
          id
          legacy_id
          account_id
          shop_name
          name
          url
          source
          enabled
          health
          created_at
          updated_at
          last_enabled_change
          shared_signature_secret
        }
        cursor
      }
    }
  }
}

Variables

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "analyze": true
}

Response

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