Self-Service Actions
Last updated
Last updated
/public/v1/self-services/actions
Assign an icon for this self service action
day2
, create
, delete
webhook
active
, archived
, draft
curl -L \
--request POST \
--url 'https://app.configure8.io/public/v1/self-services/actions' \
--header 'Content-Type: application/json' \
--data '{"name":"text","webhookUrl":"text","webhookHeaders":{},"webhookPayload":{},"icon":{},"permissions":{},"type":"day2","method":"webhook","status":"active","inputs":[{"required":false,"title":"text","payloadName":"text","defaultValue":{},"multiple":false,"dataset":{},"filter":{"column":"text","operator":"eq","and":[{"column":"owners","operator":"eq","value":"{{user.id}}"}],"or":[{"column":"owners","operator":"eq","value":"{{user.id}}"}],"value":"{{user.id}}"},"sensitive":true,"inputSize":{},"type":"text","options":[{"value":"text","label":"text"}],"condition":[{"or":{},"and":{},"not":{},"then":{"required":false,"defaultValue":{},"dataset":{},"options":[{"value":"text","label":"text"}]},"else":{"required":false,"defaultValue":{},"dataset":{},"options":[{"value":"text","label":"text"}]},"when":[null]}],"children":[{"required":false,"title":"text","payloadName":"text","defaultValue":{},"multiple":false,"dataset":{},"filter":{"column":"text","operator":"eq","and":[{"column":"owners","operator":"eq","value":"{{user.id}}"}],"or":[{"column":"owners","operator":"eq","value":"{{user.id}}"}],"value":"{{user.id}}"},"sensitive":true,"inputSize":{},"type":"text","options":[{"value":"text","label":"text"}],"condition":[{"or":{},"and":{},"not":{},"then":{"required":false,"defaultValue":{},"dataset":{},"options":[{"value":"text","label":"text"}]},"else":{"required":false,"defaultValue":{},"dataset":{},"options":[{"value":"text","label":"text"}]},"when":[null]}],"children":["[Circular Reference]"]}]}],"generalAccess":["read"],"appliesTo":["service"]}'
{
"id": "text",
"name": "text",
"description": "text",
"orgId": "text",
"createdBy": "text",
"createdAt": "2025-02-21T18:04:43.922Z",
"updatedAt": "2025-02-21T18:04:43.922Z",
"lastUsedAt": "2025-02-21T18:04:43.922Z",
"webhookUrl": "text",
"webhookQueryParams": "text",
"permissions": {},
"type": "day2",
"status": "active",
"method": "webhook",
"inputs": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"helpText": "text",
"sensitive": true,
"childrenTitle": "text",
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"sensitive": true,
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
"[Circular Reference]"
]
}
]
}
],
"webhookHeaders": "text",
"webhookPayload": "text",
"appliesTo": [
"service"
],
"generalAccess": [
"read"
],
"icon": "text"
}
/public/v1/self-services/actions
Runs %LIKE% search. Max allowed length is 100
Min allowed value is 1. Max allowed value is 50
id
, name
, lastUsedAt
, updatedAt
, status
, type
ASC
, DESC
curl -L \
--url 'https://app.configure8.io/public/v1/self-services/actions'
{
"totalFound": 1,
"pageSize": 1,
"pageNumber": 1,
"items": [
{
"id": "text",
"name": "text",
"updatedAt": "2025-02-21T18:04:43.922Z",
"lastUsedAt": "2025-02-21T18:04:43.922Z",
"permissions": {},
"createdAt": "2025-02-21T18:04:43.922Z",
"type": "day2",
"status": "active",
"method": "webhook",
"owners": [
{
"id": "text",
"name": "text",
"email": "text",
"@type": "application"
}
],
"appliesTo": [
"service"
],
"generalAccess": [
"read"
],
"icon": "text"
}
]
}
/public/v1/self-services/actions/{id}
Assign an icon for this self service action
day2
, create
, delete
webhook
active
, archived
, draft
curl -L \
--request PUT \
--url 'https://app.configure8.io/public/v1/self-services/actions/{id}' \
--header 'Content-Type: application/json' \
--data '{"name":"text","webhookUrl":"text","webhookHeaders":{},"webhookPayload":{},"icon":{},"permissions":{},"type":"day2","method":"webhook","status":"active","inputs":[{"required":false,"title":"text","payloadName":"text","defaultValue":{},"multiple":false,"dataset":{},"filter":{"column":"text","operator":"eq","and":[{"column":"owners","operator":"eq","value":"{{user.id}}"}],"or":[{"column":"owners","operator":"eq","value":"{{user.id}}"}],"value":"{{user.id}}"},"sensitive":true,"inputSize":{},"type":"text","options":[{"value":"text","label":"text"}],"condition":[{"or":{},"and":{},"not":{},"then":{"required":false,"defaultValue":{},"dataset":{},"options":[{"value":"text","label":"text"}]},"else":{"required":false,"defaultValue":{},"dataset":{},"options":[{"value":"text","label":"text"}]},"when":[null]}],"children":[{"required":false,"title":"text","payloadName":"text","defaultValue":{},"multiple":false,"dataset":{},"filter":{"column":"text","operator":"eq","and":[{"column":"owners","operator":"eq","value":"{{user.id}}"}],"or":[{"column":"owners","operator":"eq","value":"{{user.id}}"}],"value":"{{user.id}}"},"sensitive":true,"inputSize":{},"type":"text","options":[{"value":"text","label":"text"}],"condition":[{"or":{},"and":{},"not":{},"then":{"required":false,"defaultValue":{},"dataset":{},"options":[{"value":"text","label":"text"}]},"else":{"required":false,"defaultValue":{},"dataset":{},"options":[{"value":"text","label":"text"}]},"when":[null]}],"children":["[Circular Reference]"]}]}],"generalAccess":["read"],"appliesTo":["service"]}'
{
"id": "text",
"name": "text",
"description": "text",
"orgId": "text",
"createdBy": "text",
"createdAt": "2025-02-21T18:04:43.922Z",
"updatedAt": "2025-02-21T18:04:43.922Z",
"lastUsedAt": "2025-02-21T18:04:43.922Z",
"webhookUrl": "text",
"webhookQueryParams": "text",
"permissions": {},
"type": "day2",
"status": "active",
"method": "webhook",
"inputs": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"helpText": "text",
"sensitive": true,
"childrenTitle": "text",
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"sensitive": true,
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
"[Circular Reference]"
]
}
]
}
],
"webhookHeaders": "text",
"webhookPayload": "text",
"appliesTo": [
"service"
],
"generalAccess": [
"read"
],
"icon": "text"
}
/public/v1/self-services/actions/{id}
curl -L \
--url 'https://app.configure8.io/public/v1/self-services/actions/{id}'
{
"id": "text",
"name": "text",
"description": "text",
"orgId": "text",
"createdBy": "text",
"createdAt": "2025-02-21T18:04:43.922Z",
"updatedAt": "2025-02-21T18:04:43.922Z",
"lastUsedAt": "2025-02-21T18:04:43.922Z",
"webhookUrl": "text",
"webhookQueryParams": "text",
"permissions": {},
"type": "day2",
"status": "active",
"method": "webhook",
"inputs": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"helpText": "text",
"sensitive": true,
"childrenTitle": "text",
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"sensitive": true,
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
"[Circular Reference]"
]
}
]
}
],
"webhookHeaders": "text",
"webhookPayload": "text",
"appliesTo": [
"service"
],
"generalAccess": [
"read"
],
"icon": "text"
}
/public/v1/self-services/actions/{id}
curl -L \
--request DELETE \
--url 'https://app.configure8.io/public/v1/self-services/actions/{id}'
No body
Self service action deleted
/public/v1/self-services/results
Runs %LIKE% search. Max allowed length is 100
Min allowed value is 1. Max allowed value is 50
id
, name
, startedAt
, completedAt
, duration
, status
ASC
, DESC
curl -L \
--url 'https://app.configure8.io/public/v1/self-services/results'
{
"total": 1,
"pageSize": 1,
"pageNumber": 1,
"items": [
{
"id": "text",
"actionId": "text",
"orgId": "text",
"triggeredBy": "text",
"startedAt": "2025-02-21T18:04:43.922Z",
"completedAt": "2025-02-21T18:04:43.922Z",
"duration": 1,
"status": "inprogress",
"user": {
"displayName": "text",
"photoUrl": "text"
},
"appliedFrom": {
"id": "text",
"name": "text",
"type": "application"
},
"action": {
"id": "text",
"name": "text",
"permissions": {},
"appliesTo": "application",
"generalAccess": "read",
"icon": {
"color": "text",
"icon": "text"
}
}
}
]
}
/public/v1/self-services/token/{id}//{resultId}
ssa action id
ssa result id
curl -L \
--url 'https://app.configure8.io/public/v1/self-services/token/{id}/{resultId}'
{
"token": "text"
}
/public/v1/self-services/results/{id}//{resultId}
curl -L \
--url 'https://app.configure8.io/public/v1/self-services/results/{id}/{resultId}'
{
"id": "text",
"actionId": "text",
"orgId": "text",
"triggeredBy": "text",
"startedAt": "2025-02-21T18:04:43.922Z",
"completedAt": "2025-02-21T18:04:43.922Z",
"duration": 1,
"webhookUrl": "text",
"webhookQueryParams": "text",
"webhookHeaders": {},
"webhookPayload": {},
"status": "inprogress",
"method": "webhook",
"response": [
{
"title": "text",
"startedAt": "2025-02-21T18:04:43.922Z",
"completedAt": "2025-02-21T18:04:43.922Z",
"status": "inprogress",
"logs": [
"text"
]
}
],
"userInputs": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"helpText": "text",
"sensitive": true,
"childrenTitle": "text",
"inputSize": {},
"value": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"is": "text",
"in": "text",
"notIn": "text",
"isNotEmpty": true,
"isEmpty": true,
"pattern": "text",
"notMatch": true,
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
"text"
]
}
],
"children": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"helpText": "text",
"sensitive": true,
"childrenTitle": "text",
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"sensitive": true,
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
"[Circular Reference]"
]
}
]
}
]
}
],
"user": {
"displayName": "text",
"photoUrl": "text"
},
"appliedFrom": {
"id": "text",
"name": "text",
"permissions": {},
"type": "application",
"generalAccess": "read"
},
"action": {
"id": "text",
"name": "text",
"description": "text",
"permissions": {},
"appliesTo": "application",
"generalAccess": "read",
"icon": {
"color": "text",
"icon": "text"
}
}
}
/public/v1/self-services/actions/{id}/run
curl -L \
--url 'https://app.configure8.io/public/v1/self-services/actions/{id}/run'
{
"id": "text",
"name": "text",
"description": "text",
"orgId": "text",
"createdBy": "text",
"createdAt": "2025-02-21T18:04:43.922Z",
"updatedAt": "2025-02-21T18:04:43.922Z",
"lastUsedAt": "2025-02-21T18:04:43.922Z",
"webhookUrl": "text",
"webhookQueryParams": "text",
"permissions": {},
"type": "day2",
"status": "active",
"method": "webhook",
"inputs": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"helpText": "text",
"sensitive": true,
"childrenTitle": "text",
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
{
"required": false,
"title": "text",
"payloadName": "text",
"defaultValue": {},
"multiple": false,
"dataset": {},
"filter": {
"column": "text",
"operator": "eq",
"and": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"or": [
{
"column": "owners",
"operator": "eq",
"value": "{{user.id}}"
}
],
"value": "{{user.id}}"
},
"sensitive": true,
"inputSize": {},
"type": "text",
"options": [
{
"value": "text",
"label": "text"
}
],
"condition": [
{
"or": {},
"and": {},
"not": {},
"then": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"else": {
"required": false,
"defaultValue": {},
"dataset": {},
"options": [
{
"value": "text",
"label": "text"
}
]
},
"when": [
null
]
}
],
"children": [
"[Circular Reference]"
]
}
]
}
],
"webhookHeaders": "text",
"webhookPayload": "text",
"appliesTo": [
"service"
],
"generalAccess": [
"read"
],
"icon": "text"
}
/public/v1/self-services/actions/{id}/run
Id of the catalog that this action ran from
Type of the catalog that this action ran from
curl -L \
--request POST \
--url 'https://app.configure8.io/public/v1/self-services/actions/{id}/run' \
--header 'Content-Type: application/json' \
--data '{"inputs":[{}]}'
No body
Returned when filter is invalid