---
title: IP Forwarder Widget
---

The IP Forwarder widget automatically detects and tracks changes to the current public IP address of the device it runs on and stores the value in the project configuration under a configurable key. It polls on a configurable interval so the stored IP stays in sync over time.

## Widget Name

`WIDGET_IP_FORWARDER` (`"IpForwarderWidget"`)

**Category**: `utility`
**Visible in catalog**: yes

## Configuration

| Property | Type | Required | Default | Description |
|---|---|---|---|---|
| `configurationKey` | `string` | Yes | — | Project configuration key under which the current public IP address is stored. Must start with a lowercase letter and may contain lowercase letters, digits, and dots. Length 1–100. |
| `refreshInMinutes` | `number` | Yes | `60` | How often (in minutes) the widget re-checks the public IP address. Range: 1 to 1440 (24 hours). |

## Example Configuration

```typescript
// Widget data object for the IpForwarder widget
const ipForwarderWidgetData = {
    configurationKey: "network.publicIp",
    refreshInMinutes: 60
};
```

## Related

- [Widget System](../developer/widget-system.md)