Sign in

v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB
Addons

Update an addon

Update the addon with a specific ID. Any fields in the update object will be updated. Properties that are not included in the update object will not be affected. To empty a property, pass null as that property's value.

Note: passing null as a value for the description property will set it to an empty string.

put/api/admin/addons/{id}

Path parameters

idstring required

Request body

providerstring 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. The default supported options are:

The provider you choose for your addon dictates what properties the parameters object needs. Refer to the documentation for each provider for more information.

descriptionstring

A description of the addon.

enabledboolean required

Whether the addon should be enabled or not.

parametersobject 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.

eventsstring[] required

The event types that will trigger this specific addon.

projectsstring[]

The projects that this addon will listen to events from. An empty list means it will listen to events from all projects.

environmentsstring[]

The list of environments that this addon will listen to events from. An empty list means it will listen to events from all environments.

Example request

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

Response

addonSchema

idinteger required

The addon's unique identifier.

providerstring required

The addon provider, such as "webhook" or "slack".

descriptionstring nullable required

A description of the addon. null if no description exists.

enabledboolean required

Whether the addon is enabled or not.

parametersobject required

Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose.

eventsstring[] required

The event types that trigger this specific addon.

projectsstring[]

The projects that this addon listens to events from. An empty list means it listens to events from all projects.

environmentsstring[]

The list of environments that this addon listens to events from. An empty list means it listens to events from all environments.

Example response

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