> For the complete documentation index, see [llms.txt](https://help.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/reach-out-to-partners/generate-leads/create-a-custom-widget.md).

# Create a Custom Widget

Develop dynamic tools that empower partners to promote your brand. Custom widgets allow you to embed externally-hosted tools or pages directly into the impact.com interface via an iframe. Use this guide to create and configure a custom content widget that provides personalized resources and a consistent brand experience for your partners.

{% stepper %}
{% step %}

#### Access the custom widget creator

1. From the left navigation menu, select ![](/files/CDnwOBeIdds9r3Z6zTnO) **\[Engage]** → **Content** → [**Widgets**](https://app.impact.com/secure/advertiser/engage/ads/list-widget-tool-flow.ihtml)**.**
2. In the top-right corner, select **Create Widget** → **Custom**.
   {% endstep %}

{% step %}

#### Enter widget details

1. Enter a **Name** of the custom widget.
2. Optionally, enter a **Description** for the custom widget.
3. Optionally, enter a **Label** for the custom widget.
4. If required, ![](/files/OoA2qxPalfCYKZvmxuU6) **\[Toggle on] Restrict Partner Access** to specify individual partners and groups that should have access to the widget.
   * **Partners:** Enter the name of the partners that can access the custom widget.
   * **Groups:** Enter the name of the groups that can access the custom widget.
     {% endstep %}

{% step %}

#### Configure the widget

1. Select how the widget behaves from the display options:
   * **Open in new tab:** Opens the hosted URL in a separate tab.
   * **Embed in impact.com:** Displays the widget directly within the platform interface.
2. Optionally, from the **Preview Image** section, select **Choose File** to upload a thumbnail. Ensure the file is a GIF, JPG, or PNG and does not exceed 512 KB.
3. In the **Widget URL** field, enter the web address where your widget is hosted.
4. From the ![](/files/jA6jLZ1RleK5VI2zmvap)**\[Drop-down menu]**, select the protocol (e.g., https\://) that matches your site's security.
5. Optionally, select ![](/files/Gl8lj5gLPbgSXGH8yWYa) **\[Add] Insert dynamic fields** to expand the token list.
6. Locate the token you want to use and select **Insert**. The platform will automatically append the token (e.g., {irpid}) to your **Widget URL**. Refer to the [Dynamic field tokens](#dynamic-field-tokens) section below for a description of each token.
   {% endstep %}

{% step %}

#### Update advanced settings

From the **Language** ![](/files/jA6jLZ1RleK5VI2zmvap)**\[Drop-down menu]**, select the language in which this widget will display.
{% endstep %}

{% step %}

#### Finalize the custom widget

Select **Create** to save your widget. Partners can find this widget in *Content Widgets*.
{% endstep %}
{% endstepper %}

<details>

<summary>Dynamic field tokens</summary>

| Token                          | Description                                          |
| ------------------------------ | ---------------------------------------------------- |
| `{click_url_encoded}`          | Click URL encoded                                    |
| `{click_url}`                  | Click URL not encoded                                |
| `{irimpurl}`                   | Our impression URL                                   |
| `{irpid}`                      | Partner ID                                           |
| `{subid1}`                     | Partner sub ID 1                                     |
| `{subid2}`                     | Partner sub ID 2                                     |
| `{subid3}`                     | Partner sub ID 3                                     |
| `{sharedId}`                   | Shared ID                                            |
| `{iradid}`                     | Ad ID                                                |
| `{ircid}`                      | Program ID                                           |
| `{click_url_encoded_deeplink}` | Encoded click URL with appended deep link parameter. |

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/reach-out-to-partners/generate-leads/create-a-custom-widget.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
