ServerPixel

object

Requires read_pixels access scope. Also: The app must have the read_server_pixels access scope.

A server pixel stores configuration for streaming customer interactions to an EventBridge or PubSub endpoint.

Anchor to FieldsFields

Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to statusstatus • ServerPixelStatus: The current state of this server pixel.
Anchor to webhookEndpointAddresswebhookEndpointAddress • String: Address of the EventBridge or PubSub endpoint.

Was this section helpful?

Anchor to serverPixel serverPixel • query: The server pixel configured by the app.

Was this section helpful?

Anchor to eventBridgeServerPixelUpdate eventBridgeServerPixelUpdate • mutation: Updates the server pixel to connect to an EventBridge endpoint. Running this mutation deletes any previous subscriptions for the server pixel.
Anchor to pubSubServerPixelUpdate pubSubServerPixelUpdate • mutation: Updates the server pixel to connect to a Google PubSub endpoint. Running this mutation deletes any previous subscriptions for the server pixel.
Anchor to serverPixelCreate serverPixelCreate • mutation: Creates a new unconfigured server pixel. A single server pixel can exist for an app and shop combination. If you call this mutation when a server pixel already exists, then an error will return.

Was this section helpful?

Was this section helpful?