> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gethinto.com/llms.txt
> Use this file to discover all available pages before exploring further.

# JourneyHandle

> One journey instance.

One journey instance. Each call reports one step. Invalid calls, calls after `succeed()`, and
calls past 200 steps report nothing; with `debug` on, the SDK logs why.

## Properties

<ResponseField name={"instanceId"} type={"string | null"} required>
  The instance this handle reports to, or null when the handle is inert.
</ResponseField>

<ResponseField name={"key"} type={"string"} required>
  The journey key this handle reports.
</ResponseField>

## Methods

### attempt()

```typescript
attempt(action: string, options?: JourneyAttemptOptions): void
```

Reports that the customer tried `action`, a token. Call it before the request.

#### Parameters

<ResponseField name={"action"} type={"string"} required />

<ResponseField name={"options"} type={"JourneyAttemptOptions"} typeHref={"/sdk/index/interfaces/JourneyAttemptOptions"} />

### fail()

```typescript
fail(options?: JourneyFailOptions): void
```

Reports a failed attempt.

#### Parameters

<ResponseField name={"options"} type={"JourneyFailOptions"} typeHref={"/sdk/index/interfaces/JourneyFailOptions"} />

### succeed()

```typescript
succeed(options?: JourneySucceedOptions): void
```

Reports success after the server confirms it. Success closes the instance.

#### Parameters

<ResponseField name={"options"} type={"JourneySucceedOptions"} typeHref={"/sdk/index/interfaces/JourneySucceedOptions"} />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.