---
title: "Create a new addon"
method: POST
path: "/api/admin/addons"
tags: ["Addons"]
---

# Create a new addon

`POST /api/admin/addons`

Create an addon instance. The addon must use one of the providers available on this Unleash instance.

## Request body

- AddonCreateUpdateSchema — Data required to create or update an [Unleash addon](https://docs.getunleash.io/integrate) instance.
  - `provider` string, required — The addon provider, such as "webhook" or "slack". This string is **case sensitive** and maps to the provider's `name` property. The list of all supported providers and their parameters for a specific Unleash instance can be found by making a GET request to the `api/admin/addons` endpoint: the `providers` property of that response will contain all available providers. The default set of providers can be found in the [addons reference documentation](https://docs.getunleash.io/integrate). The default supported options are: - `datadog` for [Datadog](https://docs.getunleash.io/integrate/datadog) - `slack` for [Slack](https://docs.getunleash.io/integrate/slack) - `teams-workflow` for [Microsoft Teams Workflow](https://docs.getunleash.io/integrate/teams-workflow) - `webhook` for [webhooks](https://docs.getunleash.io/integrate/webhook) The provider you choose for your addon dictates what properties the `parameters` object needs. Refer to the documentation for each provider for more information.
  - `description` string — A description of the addon.
  - `enabled` boolean, required — Whether the addon should be enabled or not.
  - `parameters` object, required — Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose. Consult the documentation for details.
  - `events` string[], required — The event types that will trigger this specific addon.
  - `projects` string[] — The projects that this addon will listen to events from. An empty list means it will listen to events from **all** projects.
  - `environments` string[] — The list of environments that this addon will listen to events from. An empty list means it will listen to events from **all** environments.

## Response `200`

addonSchema

- AddonSchema — An [addon](https://docs.getunleash.io/integrate) instance description. Contains data about what kind of provider it uses, whether it's enabled or not, what events it listens for, and more.
  - `id` integer, required — The addon's unique identifier.
  - `provider` string, required — The addon provider, such as "webhook" or "slack".
  - `description` string, nullable, required — A description of the addon. `null` if no description exists.
  - `enabled` boolean, required — Whether the addon is enabled or not.
  - `parameters` object, required — Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose.
  - `events` string[], required — The event types that trigger this specific addon.
  - `projects` string[] — The projects that this addon listens to events from. An empty list means it listens to events from **all** projects.
  - `environments` string[] — The list of environments that this addon listens to events from. An empty list means it listens to events from **all** environments.

## Other responses

- `400` — The request data does not match what we expect.
- `401` — Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
- `403` — The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- `413` — The request body is larger than what we accept. By default we only accept bodies of 100kB or less
- `415` — The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

---

[API](https://skmtc.net/unleash/apis/unleash-api-3.md) · [All operations](https://skmtc.net/unleash/apis/unleash-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unleash/unleash-api-3/revisions/b2c3116e633e/schema)