Get a specific addon

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

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Path parameters

idstringRequired

Response

addonSchema
idinteger>=1
The addon's unique identifier.
providerstring
The addon provider, such as "webhook" or "slack".
descriptionstring or null

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

enabledboolean
Whether the addon is enabled or not.
parametersmap from strings to any
Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose.
eventslist of strings
The event types that trigger this specific addon.
projectslist of strings or null

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

environmentslist of strings or null

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

Errors