Sign in

v7

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

Get a specific addon

Retrieve information about the addon whose ID matches the ID in the request URL.

get/api/admin/addons/{id}

Path parameters

idstring required

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"
  ]
}