ServerPixel - admin-graphql - OBJECT

Version: 2024-10

Description:

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

Access Scopes

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

Fields

  • id: ID! - A globally-unique ID.
  • status: ServerPixelStatus - The current state of this server pixel.
  • webhookEndpointAddress: String - Address of the EventBridge or PubSub endpoint.

Connections

Related queries

  • serverPixel The server pixel configured by the app.

Related mutations

  • eventBridgeServerPixelUpdate Updates the server pixel to connect to an EventBridge endpoint. Running this mutation deletes any previous subscriptions for the server pixel.
  • pubSubServerPixelUpdate Updates the server pixel to connect to a Google PubSub endpoint. Running this mutation deletes any previous subscriptions for the server pixel.
  • serverPixelCreate 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.

Related Unions

Examples