Plugin

Invoke a plugin function

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

post/v1/plugins/{pluginId}/invoke

Request

Base URL: https://example.com/api
URL: https://example.com/api/v1/plugins/{pluginId}/invoke
Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: plugin.read)

functionstring required

scope_idstring required

Composite or bare resource ID the call is scoped to.

payloadunknown

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

okboolean required

errorstring

dataunknown