Skip to content

Notion: Cancel a session

Notion sessions.cancelSession: arguments, response, policy and SDK examples.

← Sessions operations · Get started

Operation notion.cancel_session

Provider route: POST /v1/sessions/{session_id}/cancel. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/notion with npm, or alter-sdk-notion with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { NotionIntegration } from "@alter-ai/notion";
async function execute(input: Parameters<NotionIntegration["sessions"]["cancelSession"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new NotionIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.sessions.cancelSession(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_notion import NotionIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = NotionIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.sessions.cancel_session(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.session_idstringRequired within parentThe ID of the session to cancel.
bodyobjectRequired within parentAdditional keys: not allowed
body.event_idstringOptionalA session event identifying the turn to cancel. If omitted, cancels the current nonterminal turn.

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
agent_idstringRequired within parent
created_atstringRequired within parentFormat: date-time
errorobjectOptionalAdditional keys: allowed
error.codestringRequired within parent
error.messagestringRequired within parent
error.retryablebooleanRequired within parent
idstringRequired within parent
objectstringRequired within parentAlways `session`
Must equal: session
required_actionsarrayOptionalMaximum items: 100
required_actions[]objectEach itemAdditional keys: allowed
required_actions[].action_idstringRequired within parent
required_actions[].optionsarrayRequired within parentMaximum items: 100
required_actions[].options[]objectEach itemAdditional keys: allowed
required_actions[].options[].idstringRequired within parentOne of: `approve`, `reject`
Known values: approve, reject
required_actions[].options[].labelstringRequired within parent
required_actions[].titlestringRequired within parent
statusstringRequired within parentOne of: `queued`, `in_progress`, `requires_action`, `completed`, `failed`, `canceled`, `terminated`
Known values: queued, in_progress, requires_action, completed, failed, canceled, terminated
titlestringRequired within parent
updated_atstringRequired within parentFormat: date-time

SDK function policy ID: notion.cancel_session. Catalog operation: cancel_session. 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.

Pinned headers: {"Notion-Version": "2026-03-11"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.