Cancel Chat Session Method

Go to Product

Cancel an active ChatKit session and return its most recent metadata.

Cancelling prevents new requests from using the issued client secret.

Options

Session Id
Unique identifier for the ChatKit session to cancel.
Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

  • Id: Identifier for the ChatKit session.
  • Object: Type discriminator that is always chatkit.session.
  • Expires At: Unix timestamp (in seconds) for when the session expires.
  • Client Secret: Ephemeral client secret that authenticates session requests.
  • Workflow: Workflow metadata and state returned for the session.
  • User: User identifier associated with the session.
  • Rate Limits: Active per-minute request limit for the session.
  • Max Requests Per 1 Minute: Convenience copy of the per-minute request limit.
  • Status:
  • Chatkit Configuration: ChatKit configuration for the session.

Raw Response: Returns the raw response in a single row with the following columns:

  • body: Response body
  • status: HTTP status code

Input Ports

Icon
Configuration data.

Output Ports

Icon
Result of the request depending on the selected Result Format.
Icon
Configuration data (this is the same as the input port; it is provided as passthrough for sequentially chaining nodes to declutter your workflow connections).

Popular Predecessors

  • No recommendations found

Popular Successors

  • No recommendations found

Views

This node has no views

Workflows

  • No workflows found

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.