Rippling: Create a new sandbox
Rippling restApi.createSandboxes: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.create_sandboxes
Provider route: POST /sandboxes/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["createSandboxes"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.createSandboxes(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.create_sandboxes(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create a new sandbox — request body — body |
Referenced models: Create a new sandbox — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
description | string | Optional | Optional sandbox description. |
handle | string | Optional | Server-generated sandbox handle. |
id | string | Required within parent | Identifier field |
name | string | Required within parent | Display name of the sandbox. |
status | string | Optional | Current lifecycle status. |
type | string | Required within parent | Sandbox type. Supported value: “developer”. Known values: developer |
updated_at | string | Required within parent | Record update date |
Schemas
Section titled “Schemas”Create a new sandbox — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
config_override | object | Optional | Optional create-only sandbox configuration. |
config_override.custom_objects | object | Optional | Custom objects copied into the sandbox. |
config_override.custom_objects.co_api_names | array | Optional | Custom object API names copied into the sandbox. |
config_override.custom_objects.co_api_names[] | string | Each item | |
config_override.developer | object | Optional | Required for developer sandboxes and omitted for full-data sandboxes. |
config_override.developer.company_size | string | Required within parent | Seed company size for the developer sandbox. MEDIUM is the supported value for new sandboxes. SMALL is retained for existing sandboxes only and is not supported on create. One of: SMALL, MEDIUM |
config_override.general_notifications | object | Optional | General outbound notification controls. |
config_override.general_notifications.email | object | Required within parent | Email notification configuration. |
config_override.general_notifications.email.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.email.allowed_users[] | string | Each item | |
config_override.general_notifications.email.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.general_notifications.push_notifications | object | Required within parent | Push notification configuration. |
config_override.general_notifications.push_notifications.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.push_notifications.allowed_users[] | string | Each item | |
config_override.general_notifications.push_notifications.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.general_notifications.slack | object | Optional | Slack notification configuration. |
config_override.general_notifications.slack.allowed_public_channels | array | Optional | Public channels allowed to receive outbound messages. |
config_override.general_notifications.slack.allowed_public_channels[] | string | Each item | |
config_override.general_notifications.slack.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.slack.allowed_users[] | string | Each item | |
config_override.general_notifications.slack.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.general_notifications.sms | object | Required within parent | SMS notification configuration. |
config_override.general_notifications.sms.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.sms.allowed_users[] | string | Each item | |
config_override.general_notifications.sms.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.general_notifications.teams | object | Optional | Microsoft Teams notification configuration. |
config_override.general_notifications.teams.allowed_public_channels | array | Optional | Public channels allowed to receive outbound messages. |
config_override.general_notifications.teams.allowed_public_channels[] | string | Each item | |
config_override.general_notifications.teams.allowed_users | array | Optional | Users allowed to receive outbound messages. |
config_override.general_notifications.teams.allowed_users[] | string | Each item | |
config_override.general_notifications.teams.outbound_behavior | string | Required within parent | Whether outbound messages are allowed or suppressed. One of: SUPPRESS, ALLOW |
config_override.integrations | object | Optional | Required for connected full-data sandboxes. |
config_override.integrations.is_risk_acknowledged | boolean | Required within parent | Confirms acceptance of the risks of connected third-party integrations. |
config_override.sandbox_mode | string | Optional | Required for full-data sandboxes. Developer sandboxes default to CONNECTED. One of: CONNECTED, ISOLATED |
config_override.workflow_webhooks | object | Optional | Workflow webhook controls. |
config_override.workflow_webhooks.allowed_ips | array | Optional | IP addresses allowed to receive workflow webhooks. |
config_override.workflow_webhooks.allowed_ips[] | string | Each item | |
config_override.workflow_webhooks.allowlisted_webhook_urls | array | Optional | Webhook URLs allowed in the sandbox. |
config_override.workflow_webhooks.allowlisted_webhook_urls[] | string | Each item | |
config_override.workflow_webhooks.outbound_behavior | string | Optional | Whether workflow webhook traffic is allowed or suppressed. One of: SUPPRESS, ALLOW |
description | string | Optional | Optional sandbox description. |
name | string | Required within parent | Display name of the sandbox. |
type | string | Required within parent | Sandbox type. Supported value: "developer". One of: developer |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.create_sandboxes. Catalog operation: create-sandboxes. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["sandboxes.read-write"]
Provider entitlements: ["Developer_Base"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}