Skip to navigation

Get plugin

View as Markdown

Returns one plugin by its id. Secrets come back redacted.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the plugin, as returned when it was created or listed.

Response

The plugin
basic_infoobjectOptional
Name and description of the plugin, as shown to users.
launch_configobjectOptional
Who can use the plugin, whether analytics are enabled, and how logs are redacted. If omitted, analytics are disabled and standard log redaction is used.
triggering_configobjectOptional

What triggers the plugin. Set exactly one of custom_triggering_config or system_triggering_config.

execution_configobjectOptional

What the plugin runs. Must match the trigger: conversational triggers run a conversational process; system triggers run an action.

idstringOptionalRead-only
Unique identifier of the plugin, assigned by the server.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error