eventBridgeServerPixelUpdate

Updates the server pixel to connect to an EventBridge endpoint. Running this mutation deletes any previous subscriptions for the server pixel.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the eventBridgeServerPixelUpdate action (under Event).
Fill in the fields below, then reference the result from later steps as {{eventbridgeserverpixelupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation EventBridgeServerPixelUpdate($arn: ARN!) {
  eventBridgeServerPixelUpdate(arn: $arn) {
    serverPixel {
      id
      status
      webhookEndpointAddress
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

arnstringrequired

The ARN for the EventBridge endpoint to which customer events are to be sent.

json

{
  "arn": "string"
}

Response

Read the result with {{eventbridgeserverpixelupdate.response.data.data.eventBridgeServerPixelUpdate}}. If the API returns errors, the step fails and they are at {{eventbridgeserverpixelupdate.response.data.errors}}.

serverPixelobject

idstring

statusstring

One ofCONNECTEDDISCONNECTED_UNCONFIGUREDDISCONNECTED_CONFIGURED

webhookEndpointAddressstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?