configure_push #
On this page
Generated automatically from the published contract sources.
A script calls this action over HTTPS at POST https://tzcloud.turnzero.ai/v1/configure_push, with a bearer credential and the action's payload as the JSON body. An MCP connection lists this action as the tool tzcloud_configure_push.
OAuth access tokens and minted tokens, including the turnzero command's computer token, are bearer credentials. The action determines which kinds, scopes and grants it accepts (Sign-in, sessions, and tokens).
Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.
Contract description #
Configure or remove Apple and Google push providers for one environment. First store each credential for that application and environment with store_secret. This call checks its name, never its value. Your manifest must declare push. If it lists providers, submit_manifest configures them on every environment. Only Apple's gateway then needs a provider call. Other changes to manifest-provided configuration are refused manifest_owned_field.
Delivery needs the accounts service and devices registered after sign-in. Configuration takes effect on the next delivery, without a deploy. Success does not prove the credential works. After sending, check read_push and read_logs.
More about this action #
The apns member gives Apple's team and key identifiers, the app's bundle identifier, the gateway (production or sandbox), and the stored signing key's name. The fcm member gives the Firebase project and the stored service-account file's name. Each member is optional, and null removes that provider.
An optional environment (development or production; absent, production) selects which environment your call configures.
Give at least one provider per call. Omit a provider to keep it; pass null to remove it. A provider object must be complete. To change only the gateway of an Apple provider the manifest supplies, repeat its other four fields unchanged beside apns.environment. When the manifest supplies Apple, its gateway defaults to sandbox on development and production on production until this call changes it.
A credential name minted by the platform or bound to an upstream, realm route or setting is refused. Store a separate credential for this application and environment. After saving, the platform checks the name again. If the value was deleted or bound to a setting meanwhile, the configuration is taken back and the call refused. Delivery alone reads the value; a bad credential can leave configuration accepted but delivery failed.
Access and action metadata #
{
"name": "configure_push",
"resource": "push",
"tier": "reversible",
"surface": "tzcloud",
"addresses": [
"tzcloud"
],
"product": "cloud",
"summary": "Set an application environment's push providers — Apple's team, key, bundle, gateway, and stored signing-key name; Google's project and stored service-account file name — each optional, null removing one; refused by name where the manifest declares no push service, where a named secret is not in custody at that scope, or where the name is an upstream's or a realm route's credential or a setting binds it.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"openWorldHint": false
}
}
MCP catalog entry #
{
"name": "configure_push",
"title": "Configure push notifications",
"tier": "reversible",
"summary": "Configure or remove Apple and Google push providers for one environment. First store each credential for that application and environment with `store_secret`. This call checks its name, never its value. Your manifest must declare push. If it lists providers, `submit_manifest` configures them on every environment. Only Apple's gateway then needs a provider call. Other changes to manifest-provided configuration are refused `manifest_owned_field`.\n\nDelivery needs the accounts service and devices registered after sign-in. Configuration takes effect on the next delivery, without a deploy. Success does not prove the credential works. After sending, check `read_push` and `read_logs`.",
"owners": [
"PSH-L0-01",
"PLD-L0-40"
],
"scenario": "PSH-L0-01"
}
request #
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | Type: object Required fields: ["application"] Additional properties: false |
| / |
Your account's application id from list_applications, not its name or label.Type: string |
| / |
The environment you address, production where absent.Type: string Pattern: ^(development|production)$ |
| / |
Apple's provider, or null to remove it; the named secret is proved present at this environment's application scope and moved nowhere. Type: ["object","null"] Required fields: ["team_id","key_id","bundle_id","key_secret_name","environment"] Additional properties: false |
| / |
Ten-character Apple team id from your Developer membership page. Type: string |
| / |
Ten-character signing-key id from Apple's Keys page, created with the .p8 key. Type: string |
| / |
The app's bundle identifier, the notification's topic. Type: string |
| / |
The custody NAME of the stored .p8 signing key at this environment scope; never pass a value. Type: string |
| / |
Apple's gateway: sandbox for a debug build, production for a store build.Type: string Allowed values: ["production","sandbox"] |
| / |
Google's provider, or null to remove it; the named secret is proved present at this environment's application scope and moved nowhere. Type: ["object","null"] Required fields: ["project_id","service_account_secret_name"] Additional properties: false |
| / |
Firebase project id: six to thirty lowercase letters, digits or hyphens, starting with a letter. Type: string |
| / |
The custody NAME of the stored service-account JSON file at this environment scope; never pass a value. Type: string |
response #
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | Type: object Required fields: ["contract_version","push","detail"] Additional properties: false |
| / |
Required value: 1 |
| / |
Type: object Required fields: ["application","environment","apns","fcm"] Additional properties: false |
| / |
Type: string |
| / |
Type: string Allowed values: ["development","production"] |
| / |
Type: ["object","null"] Required fields: ["team_id","key_id","bundle_id","key_secret_name","environment"] Additional properties: false |
| / |
The ten-character Apple team identifier. Type: string |
| / |
The ten-character identifier of the APNs signing key. Type: string |
| / |
The app's bundle identifier, the notification's topic. Type: string |
| / |
The custody NAME of the stored .p8 signing key at this environment scope; never a value. Type: string |
| / |
Which of Apple's two gateways this environment's pushes go to. Type: string Allowed values: ["production","sandbox"] |
| / |
Type: ["object","null"] Required fields: ["project_id","service_account_secret_name"] Additional properties: false |
| / |
The Firebase project identifier. Type: string |
| / |
The custody NAME of the stored service-account JSON file at this environment scope; never a value. Type: string |
| / |
Type: string |
Complete payload contract #
{
"request": {
"type": "object",
"required": [
"application"
],
"properties": {
"application": {
"type": "string",
"description": "Your account's application `id` from `list_applications`, not its name or label."
},
"environment": {
"type": "string",
"pattern": "^(development|production)$",
"description": "The environment you address, `production` where absent."
},
"apns": {
"type": [
"object",
"null"
],
"description": "Apple's provider, or null to remove it; the named secret is proved present at this environment's application scope and moved nowhere.",
"required": [
"team_id",
"key_id",
"bundle_id",
"key_secret_name",
"environment"
],
"properties": {
"team_id": {
"type": "string",
"description": "Ten-character Apple team id from your Developer membership page."
},
"key_id": {
"type": "string",
"description": "Ten-character signing-key id from Apple's Keys page, created with the .p8 key."
},
"bundle_id": {
"type": "string",
"description": "The app's bundle identifier, the notification's topic."
},
"key_secret_name": {
"type": "string",
"description": "The custody NAME of the stored .p8 signing key at this environment scope; never pass a value."
},
"environment": {
"type": "string",
"enum": [
"production",
"sandbox"
],
"description": "Apple's gateway: `sandbox` for a debug build, `production` for a store build."
}
},
"additionalProperties": false
},
"fcm": {
"type": [
"object",
"null"
],
"description": "Google's provider, or null to remove it; the named secret is proved present at this environment's application scope and moved nowhere.",
"required": [
"project_id",
"service_account_secret_name"
],
"properties": {
"project_id": {
"type": "string",
"description": "Firebase project id: six to thirty lowercase letters, digits or hyphens, starting with a letter."
},
"service_account_secret_name": {
"type": "string",
"description": "The custody NAME of the stored service-account JSON file at this environment scope; never pass a value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"response": {
"type": "object",
"required": [
"contract_version",
"push",
"detail"
],
"properties": {
"contract_version": {
"const": 1
},
"push": {
"type": "object",
"required": [
"application",
"environment",
"apns",
"fcm"
],
"properties": {
"application": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"development",
"production"
]
},
"apns": {
"type": [
"object",
"null"
],
"required": [
"team_id",
"key_id",
"bundle_id",
"key_secret_name",
"environment"
],
"properties": {
"team_id": {
"type": "string",
"description": "The ten-character Apple team identifier."
},
"key_id": {
"type": "string",
"description": "The ten-character identifier of the APNs signing key."
},
"bundle_id": {
"type": "string",
"description": "The app's bundle identifier, the notification's topic."
},
"key_secret_name": {
"type": "string",
"description": "The custody NAME of the stored .p8 signing key at this environment scope; never a value."
},
"environment": {
"type": "string",
"enum": [
"production",
"sandbox"
],
"description": "Which of Apple's two gateways this environment's pushes go to."
}
},
"additionalProperties": false
},
"fcm": {
"type": [
"object",
"null"
],
"required": [
"project_id",
"service_account_secret_name"
],
"properties": {
"project_id": {
"type": "string",
"description": "The Firebase project identifier."
},
"service_account_secret_name": {
"type": "string",
"description": "The custody NAME of the stored service-account JSON file at this environment scope; never a value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"detail": {
"type": "string"
}
},
"additionalProperties": false
}
}
Shared contracts #
- Refusals: every refusal, by surface, with its cause and its remedy
- schemas/wire_error.schema.json
- schemas/wire_errors.json
- schemas/action_payloads.json (includes shared shapes)
- management_api_contract.md