Server
Requires 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
- •ID!non-null
A globally-unique ID.
- Anchor to statusstatus•Server
Pixel Status The current state of this server pixel.
- Anchor to webhookEndpointAddresswebhook•String
Endpoint Address Address of the EventBridge or PubSub endpoint.
Anchor to MutationsMutations
- •mutation
Updates the server pixel to connect to an EventBridge endpoint. Running this mutation deletes any previous subscriptions for the server pixel.
- •ARN!required
The ARN for the EventBridge endpoint to which customer events are to be sent.
Arguments
- Anchor to serverPixelserver•Server
Pixel Pixel The server pixel as configured by the mutation.
- Anchor to userErrorsuser•[Errors
Errors Server Pixel User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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 pubSubProjectpub•String!required
Sub Project The Google PubSub project ID.
- Anchor to pubSubTopicpub•String!required
Sub Topic The Google PubSub topic ID.
Arguments
- Anchor to serverPixelserver•Server
Pixel Pixel The server pixel as configured by the mutation.
- Anchor to userErrorsuser•[Errors
Errors Server Pixel User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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.
- Anchor to serverPixelserver•Server
Pixel Pixel The new server pixel.
- Anchor to userErrorsuser•[Errors
Errors Server Pixel User Error!]!non-null The list of errors that occurred from executing the mutation.