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

# userActionRequired

```typescript
userActionRequired(payload: unknown): undefined | null | string
```

What the agent needs from the user (cloud). Three-valued, as the protocol
defines it: a description when the cloud names the action; `null` when the
update carries the key without a value; `undefined` when the update does not
carry the key. Treat `null` as "look at the status message", not as "done".

## Parameters

**payload** `unknown` *required*

## Returns

`undefined | null | string`


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