Sign in
Plugin

Invoke a plugin function

Dispatch a named function on an enabled plugin. Disabled plugins return 404.

post/v1/plugins/{pluginId}/invoke

Request body

functionstring required
scope_idstring required

Composite or bare resource ID the call is scoped to.

{"stackTrail":"components:requestBodies:PluginInvoke:content:application/json:schema:properties:payload","oasType":"schema","type":"unknown","description":"Plugin-defined JSON payload."}

Example request

{
  "function": "startTimer",
  "scope_id": "Issue:9bsv0s46s6s002p9ltq0"
}

Response

OK

okboolean required
errorstring
{"stackTrail":"components:schemas:PluginInvokeResult:properties:data","oasType":"schema","type":"unknown","description":"Plugin-defined JSON payload."}

Changes

Changed in 1 of the 26 revisions of this API.1