# Manage custom effects

> When the built-in effects do not match your use case, you can create a custom effect.

> For the complete documentation index, see [llms.txt](https://docs.talon.one/llms.txt).

<FeatureAccessInfoBox>
Only admins and Application admins have access to this feature.
</FeatureAccessInfoBox>

Custom effects have the structure of your choice, and you can use them in your
[rules](/docs/product/rules/overview.md) like a regular effect or a [failure effect](/docs/product/rules/effects/overview.md).
They are also returned in the [Integration API](/docs/dev/integration-api/overview.md).
For example, if you run a bike rental company where customers rent by the minute,
you can create an effect to award minutes. See the [tutorial][tuto].

:::note Custom effect versus webhook
Custom effects and webhooks allow you to send data from Talon.One to the platform of
your choice.

Before choosing one over the other, consider the following:

- If you prefer receiving the data in your integration layer and parsing it like any other
  effect, use a [custom effect](/docs/product/account/dev-tools/manage-custom-effects).
- If you want the data to be sent to a specific URI,
  consider using a [webhook](/docs/product/account/dev-tools/manage-webhooks) instead.
:::

## List custom effects

1. On the leftmost menu, click <Account className="icon"/> **Account**.
1. Click <Tools className="icon"/> **Tools** \> **Custom Effects**.

This page displays the available custom effects. It contains the following information for
each of them:

| Column       | Description                                                                                               |
| ------------ | --------------------------------------------------------------------------------------------------------- |
| ID           | Unique number identifying the custom effect. It can be used for integration purposes.                     |
| Title        | Name and description of the custom effect.                                                                |
| Applications | Number of Applications the custom effect is connected to.                                                 |
| Scope        | Determines if the custom effect should be triggered on the whole session or for each item in the session. |

## Create a custom effect

1. On the leftmost menu, click <Account className="icon"/> **Account**.
1. Click <Tools className="icon"/> **Tools** \> **Custom Effects**.
1. Click **Create Custom Effect** at the top-right of the page.
1. In **Properties**, choose:
   - **Scope**: Select if the effect should be triggered once for the whole session, or for each item in the session.
   - **API name**: The API name of the custom effect as it will appear in API requests.
   - **Rule Builder name**: The name of the custom effect as it will appear in the Rule Builder.
   - **Custom effect description**: A description of what the custom effect does.
   - **Applications**: Applications where the custom effect will be available.
1. In **Parameters**, choose:
   - **Param type**: The type of parameter (string, number, boolean, time).
   - **Param name**: The name of the parameter.
   - **Param description**: A description of the parameter.
     To limit the fields to certain values, click <PicklistIcon className="icon" /> to create a Picklist.
1. In **Effect payload**, type the payload to send in the effect.
1. Click **Create**.

The custom effect becomes available in the Rule Builder for all the campaigns in the
connected Applications.

See the [tutorial][tuto].

## Edit a custom effect

You can modify some characteristics of a custom effect after it has been created. For
example, you can make it available in different Applications.

:::important
Application admins can edit custom effects that are available only in Applications of
which they are an admin.
:::

1. On the leftmost menu, click <Account className="icon"/> **Account**.
1. Click <Tools className="icon"/> **Tools** \> **Custom Effects**
1. Click the name of the custom effect you want to edit.
1. Edit the required details.

   :::note
   You cannot modify the parameters of a custom effect if you are using it.
   :::

1. Click **Save**.

## Delete a custom effect

You can delete any custom effect that is not referenced by a rule in a campaign.

:::important
Application admins can delete custom effects that are available only in Applications of
which they are an admin.
:::

1. On the leftmost menu, click <Account className="icon"/> **Account**.
1. Click <Tools className="icon"/> **Tools** \> **Collections**.
1. Click the name of the custom effect you want to delete.
1. Click **Delete Custom Effect** at the top-right of the page.
1. Click **Delete Custom Effect** on the confirmation pop-up that appears.

## Related pages

- [Use effects](/docs/product/rules/effects/use-effects.md)
- [API effects](/docs/dev/integration-api/api-effects.md)
- [Tutorial: creating a custom effect][tuto]
- [Cart item flattening](/docs/product/rules/cart-item-flattening.md)

[tuto]: /docs/dev/tutorials/create-custom-effects.md