Trigger Shopify Admin webhooks

​

Requirements

​

Create a Shopify Admin webhook

1. Go to Apps in the sidebar.
2. Open Webhooks and click Configure.
3. Click New outgoing webhook.
4. Enter a Name.
5. Set Content type to Shopify Admin.
6. Choose an Event.
7. Add your payload template (see below).
8. Click Save.

​

Template format

• query is required and must contain a GraphQL query or mutation.
• variables is optional.

{
  "query": "mutation tagsAdd($id: ID!, $tags: [String!]!) { tagsAdd(id: $id, tags: $tags) { node { id } userErrors { field message } } }",
  "variables": {
    "id": "{{ subscription.shopify_customer_id }}",
    "tags": ["subscription-active"]
  }
}

• The rendered payload is valid JSON.
• query exists at the top level.
• GraphQL syntax is valid.

​

How delivery works

• Firmhouse sends the request to Shopify Admin GraphQL.
• The request is sent as application/json.
• X-Shopify-Access-Token is added automatically.
• Http-Firmhouse-Signature is included like other outgoing webhooks.
• Failed responses are retried automatically (up to 3 attempts).

​

Verify and troubleshoot

• Request body
• Response code
• Response body

​

Related articles

• Adding, managing, and removing webhooks
• API access tokens
• Shopify Admin GraphQL API docs