Order Service
Plugins
Create a new plugin
1min
POST
HEADER PARAMETERS
X-COREOS-TID
string
*Tenant id
X-COREOS-REQUEST-ID
string
*Unique requestId
X-COREOS-ACCESS
string
*core-os access token
X-COREOS-USERINFO
string
*core-os user info token
BODY PARAMETERS
body
PluginRequestDetails
*Plugin create request
name
string
*name of the plugin
description
string
description of the plugin
httpUrl
string
*url endpoint to be called when the plugin is executed.
httpMethod
string<POST | GET | PUT>
*api method with which the endpoint is called
httpHeaders
object
Example: [object Object]
headers used to make the api call
httpRequestBodyTemplate
TemplateSchema[]
*template for getting plugin API request Body
dlqOnFailure
boolean
requestTimeout
number
Example: 20
Request timeout in seconds
callbackTimeout
number
Example: 20
Callback timeout in seconds
responseType
string<ASYNC | SYNC>
*type of response which api will return it can be sync or async.
secretKey
string
*secret key for HMAC authentication.
protocol
string<HTTP | GRPC>
plugin protocol
maxConcurrentCalls
integer
max concurrent calls allowed for a specific plugin API.
RESPONSES
201
OK
SuccessPluginResponse
error
Error
*Error Information
request
Request
*data
object
Example: [object Object]
400
Error Occurred
PostErrorResponse
error
Error
*Error Information
request
Request
*data
object
Example: [object Object]
401
Error Occurred
PostErrorResponse
error
Error
*Error Information
request
Request
*data
object
Example: [object Object]


Updated 03 Aug 2023
Did this page help you?