pushEventControls

Requires permission settings:tenant:read.

Lists, for each push channel, how a notification type is rolled out and which types an admin may turn off. Needs settings:tenant:read.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PushEventControls {
  pushEventControls {
    buyer {
      kinds
      mode
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PushEventControls {\n  pushEventControls {\n    buyer {\n      kinds\n      mode\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "pushEventControls": {
      "buyer": {
        "kinds": [
          "string"
        ],
        "mode": "string"
      }
    }
  }
}

pushEventControls: PushEventControls!

Type

PushEventControls object

The push controls of both channels.