Skip to navigation

Create plugin

View as Markdown

Creates a plugin and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required. Anything this plugin refers to must already exist.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
basic_infoobjectRequired
Name and description of the plugin, as shown to users.
triggering_configobjectRequired

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

execution_configobjectRequired

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

versionobjectRequired
Document version. On update, send back the num from your last read.
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.

Response

The created 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

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error