> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getunleash.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getunleash.io/_mcp/server.

# [BETA] Create a new addon for a project

POST https://app.unleash-instance.example.com/api/admin/projects/{projectId}/addons
Content-Type: application/json

**[BETA]** This API is in beta state, which means it may change or be removed in the future.

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

Reference: https://docs.getunleash.io/api/create-addon-for-project

## Authentication

- `Authorization` header (required) — API key needed to access this API
- `Authorization` header (bearer token, required) — API key needed to access this API, in Bearer token format

## Request

### Path parameters

- `projectId` (string, required)

### Body (application/json)

This endpoint expects an addonCreateUpdateSchema.

- `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.
- `enabled` (boolean, required) — Whether the addon should be enabled or not.
- `parameters` (map from string to any, 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` (list of string, required) — The event types that will trigger this specific addon.
- `description` (string, optional) — A description of the addon.
- `projects` (list of string, optional) — The projects that this addon will listen to events from. An empty list means it will listen to events from **all** projects.
- `environments` (list of string, optional) — 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

- `id` (integer, required) — The addon's unique identifier.
- `provider` (string, required) — The addon provider, such as "webhook" or "slack".
- `description` (string, required, nullable) — A description of the addon. `null` if no description exists.
- `enabled` (boolean, required) — Whether the addon is enabled or not.
- `parameters` (map from string to any, required) — Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose.
- `events` (list of string, required) — The event types that trigger this specific addon.
- `projects` (list of string, optional) — The projects that this addon listens to events from. An empty list means it listens to events from **all** projects.
- `environments` (list of string, optional) — The list of environments that this addon listens to events from. An empty list means it listens to events from **all** environments.

## Errors

### 400 Bad Request Error

The request data does not match what we expect.

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 401 Unauthorized Error

Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 403 Forbidden Error

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 413 Content Too Large Error

The request body is larger than what we accept. By default we only accept bodies of 100kB or less

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 415 Unsupported Media Type Error

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.

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

## Examples

**Request**

```json
{
  "provider": "webhook",
  "enabled": true,
  "parameters": {
    "url": "http://localhost:4242/webhook"
  },
  "events": [
    "feature-created",
    "feature-updated"
  ]
}
```

**Response**

```json
{
  "id": 27,
  "provider": "webhook",
  "description": "This addon posts updates to our internal feature tracking system whenever a feature is created or updated.",
  "enabled": true,
  "parameters": {
    "url": "http://localhost:4242/webhook"
  },
  "events": [
    "feature-created",
    "feature-updated"
  ],
  "projects": [
    "new-landing-project",
    "signups-v2"
  ],
  "environments": [
    "development",
    "production"
  ]
}
```

**SDK Code**

```python
import requests

url = "https://app.unleash-instance.example.com/api/admin/projects/projectId/addons"

payload = {
    "provider": "webhook",
    "enabled": True,
    "parameters": { "url": "http://localhost:4242/webhook" },
    "events": ["feature-created", "feature-updated"]
}
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/api/admin/projects/projectId/addons';
const options = {
  method: 'POST',
  headers: {Authorization: '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"provider":"webhook","enabled":true,"parameters":{"url":"http://localhost:4242/webhook"},"events":["feature-created","feature-updated"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.unleash-instance.example.com/api/admin/projects/projectId/addons"

	payload := strings.NewReader("{\n  \"provider\": \"webhook\",\n  \"enabled\": true,\n  \"parameters\": {\n    \"url\": \"http://localhost:4242/webhook\"\n  },\n  \"events\": [\n    \"feature-created\",\n    \"feature-updated\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.unleash-instance.example.com/api/admin/projects/projectId/addons")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"webhook\",\n  \"enabled\": true,\n  \"parameters\": {\n    \"url\": \"http://localhost:4242/webhook\"\n  },\n  \"events\": [\n    \"feature-created\",\n    \"feature-updated\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.unleash-instance.example.com/api/admin/projects/projectId/addons")
  .header("Authorization", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"webhook\",\n  \"enabled\": true,\n  \"parameters\": {\n    \"url\": \"http://localhost:4242/webhook\"\n  },\n  \"events\": [\n    \"feature-created\",\n    \"feature-updated\"\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.unleash-instance.example.com/api/admin/projects/projectId/addons', [
  'body' => '{
  "provider": "webhook",
  "enabled": true,
  "parameters": {
    "url": "http://localhost:4242/webhook"
  },
  "events": [
    "feature-created",
    "feature-updated"
  ]
}',
  'headers' => [
    'Authorization' => '<apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/api/admin/projects/projectId/addons");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"provider\": \"webhook\",\n  \"enabled\": true,\n  \"parameters\": {\n    \"url\": \"http://localhost:4242/webhook\"\n  },\n  \"events\": [\n    \"feature-created\",\n    \"feature-updated\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "provider": "webhook",
  "enabled": true,
  "parameters": ["url": "http://localhost:4242/webhook"],
  "events": ["feature-created", "feature-updated"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/api/admin/projects/projectId/addons")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```