---
title: "URLInput"
summary: "@slack/web-api / URLInput"
url: "https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/URLInput"
type: "guide"
---

Source: https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/URLInput

[@slack/web-api](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api.md) / URLInput

# Interface: URLInput

Defined in: packages/types/dist/block-kit/block-elements.d.ts:608

## Description {#description}

Allows user to enter a URL into a single-line field.

## See {#see}

*   [URL input element reference](https://docs.slack.dev/reference/block-kit/block-elements/url-input-element.md).
*   [This is an interactive component - see our guide to enabling interactivity](https://docs.slack.dev/interactivity/handling-user-interaction.md).

## Extends {#extends}

*   [`Actionable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md).[`Dispatchable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/dispatchable.md).[`Focusable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/focusable.md).[`Placeholdable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/placeholdable.md)

## Properties {#properties}

### action_id? {#action_id}

```
optional action_id?: string;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:12

@description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction.md#payloads). Should be unique among all other `action_id`s in the containing block. Maximum length for this field is 255 characters.

#### Inherited from {#inherited-from}

[`Actionable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md).[`action_id`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md#action_id)

* * *

### dispatch_action_config? {#dispatch_action_config}

```
optional dispatch_action_config?: DispatchActionConfig;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:28

#### Description {#description-1}

A [DispatchActionConfig](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/dispatchactionconfig.md) object that determines when during text input the element returns a [\`block\_actions\` payload](https://docs.slack.dev/reference/interaction-payloads/block_actions-payload.md).

#### Inherited from {#inherited-from-1}

[`Dispatchable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/dispatchable.md).[`dispatch_action_config`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/dispatchable.md#dispatch_action_config)

* * *

### focus_on_load? {#focus_on_load}

```
optional focus_on_load?: boolean;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:36

#### Description {#description-2}

Indicates whether the element will be set to auto focus within the [\`view\` object](https://docs.slack.dev/surfaces/modals.md). Only one element can be set to `true`. Defaults to `false`.

#### Inherited from {#inherited-from-2}

[`Focusable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/focusable.md).[`focus_on_load`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/focusable.md#focus_on_load)

* * *

### initial_value? {#initial_value}

```
optional initial_value?: string;
```

Defined in: packages/types/dist/block-kit/block-elements.d.ts:616

#### Description {#description-3}

The initial value in the URL input when it is loaded.

* * *

### placeholder? {#placeholder}

```
optional placeholder?: PlainTextElement;
```

Defined in: packages/types/dist/block-kit/extensions.d.ts:49

#### Description {#description-4}

A [PlainTextElement](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/plaintextelement.md) object that defines the placeholder text shown on the element. Maximum length for the `text` field in this object is 150 characters.

#### Inherited from {#inherited-from-3}

[`Placeholdable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/placeholdable.md).[`placeholder`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/placeholdable.md#placeholder)

* * *

### type {#type}

```
type: "url_text_input";
```

Defined in: packages/types/dist/block-kit/block-elements.d.ts:612

#### Description {#description-5}

The type of element. In this case `type` is always `url_text_input`.

#### Overrides {#overrides}

[`Actionable`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md).[`type`](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/actionable.md#type)