Self-Service Actions

• Create a new self-service actions

• Get a list of self-service actions

• Update a self-service action by id

• Get a self-service action by id

• Delete a self-service action by id

• Get a list of self-service action results

• Get self-service action result token

• Get self-service action result by id

• Get self-service action result by id to run

• Run self-service action by id

Create a new self service action

POSThttps://app.configure8.io/public/v1/self-services/actions

Body

application/json

Self service action object to be created.

name*string

descriptionstring

type*enum

day2createdelete

inputsarray of SelfServiceActionInputSchemaDto (object)

method*enum

webhook

webhookUrl*string

webhookQueryParamsstring

webhookHeadersobject

webhookPayload*object

iconnullable object

Assign an icon for this self service action

status*enum

activearchiveddraft

permissionsobject

generalAccessarray of enum

appliesTonullable array of enum

Response

200400401403404422500

Body

application/json

id*string

name*string

descriptionstring

type*enum

day2createdelete

status*enum

activearchiveddraft

orgId*string

createdBy*string

method*enum

webhook

createdAt*string (date-time)

updatedAtstring (date-time)

lastUsedAtstring (date-time)

inputsarray of SelfServiceActionInputSchemaDto (object)

webhookUrl*string

webhookQueryParamsstring

webhookHeadersone of

Webhook headers, can be either a string or an object

stringobject

webhookPayloadone of

Webhook payload, can be either a string or an object

stringobject

iconnullable one of

stringobjectobject

permissionsobject

appliesTonullable array of enum

generalAccessarray of enum

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "day2",
      "method": "webhook",
      "webhookUrl": "text",
      "status": "active"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "day2",
  "status": "active",
  "orgId": "text",
  "createdBy": "text",
  "method": "webhook",
  "createdAt": "2024-12-21T15:41:45.509Z",
  "updatedAt": "2024-12-21T15:41:45.509Z",
  "lastUsedAt": "2024-12-21T15:41:45.509Z",
  "inputs": [
    {
      "type": "text",
      "required": false,
      "title": "text",
      "payloadName": "text",
      "multiple": false,
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ],
      "dataset": {},
      "filter": {
        "and": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "or": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "column": "text",
        "operator": "eq",
        "value": "{{user.id}}"
      },
      "helpText": "text",
      "condition": [
        {
          "when": [
            "text"
          ],
          "is": "text",
          "in": "text",
          "notIn": "text",
          "isNotEmpty": false,
          "isEmpty": false,
          "pattern": "text",
          "notMatch": false,
          "then": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          },
          "else": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          }
        }
      ],
      "sensitive": false,
      "childrenTitle": "text",
      "inputSize": {},
      "children": []
    }
  ],
  "webhookUrl": "text",
  "webhookQueryParams": "text",
  "webhookHeaders": "text",
  "webhookPayload": "text",
  "icon": "text",
  "appliesTo": [
    "service"
  ],
  "generalAccess": [
    "read"
  ]
}

Get list of self service actions

GEThttps://app.configure8.io/public/v1/self-services/actions

Query parameters

Response

200400401403500

Body

application/json

items*array of ServiceActionListItemDto (object)

totalFound*number

pageSize*number

pageNumber*number

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/actions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "type": "day2",
      "status": "active",
      "method": "webhook",
      "appliesTo": [
        "service"
      ],
      "updatedAt": "2024-12-21T15:41:45.509Z",
      "lastUsedAt": "2024-12-21T15:41:45.509Z",
      "icon": "text",
      "generalAccess": [
        "read"
      ],
      "createdAt": "2024-12-21T15:41:45.509Z",
      "owners": [
        {
          "id": "text",
          "@type": "application",
          "name": "text",
          "email": "text"
        }
      ]
    }
  ],
  "totalFound": 0,
  "pageSize": 0,
  "pageNumber": 0
}

Update a self service action by id

PUThttps://app.configure8.io/public/v1/self-services/actions/{id}

Path parameters

id*string

Body

application/json

Self service action object to be updated.

name*string

descriptionstring

type*enum

day2createdelete

inputsarray of SelfServiceActionInputSchemaDto (object)

method*enum

webhook

webhookUrl*string

webhookQueryParamsstring

webhookHeadersobject

webhookPayload*object

iconnullable object

Assign an icon for this self service action

status*enum

activearchiveddraft

permissions*object

generalAccessarray of enum

appliesTonullable array of enum

Response

200400401403404422500

Body

application/json

id*string

name*string

descriptionstring

type*enum

day2createdelete

status*enum

activearchiveddraft

orgId*string

createdBy*string

method*enum

webhook

createdAt*string (date-time)

updatedAtstring (date-time)

lastUsedAtstring (date-time)

inputsarray of SelfServiceActionInputSchemaDto (object)

webhookUrl*string

webhookQueryParamsstring

webhookHeadersone of

Webhook headers, can be either a string or an object

stringobject

webhookPayloadone of

Webhook payload, can be either a string or an object

stringobject

iconnullable one of

stringobjectobject

permissionsobject

appliesTonullable array of enum

generalAccessarray of enum

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/actions/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "day2",
      "method": "webhook",
      "webhookUrl": "text",
      "status": "active"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "day2",
  "status": "active",
  "orgId": "text",
  "createdBy": "text",
  "method": "webhook",
  "createdAt": "2024-12-21T15:41:45.509Z",
  "updatedAt": "2024-12-21T15:41:45.509Z",
  "lastUsedAt": "2024-12-21T15:41:45.509Z",
  "inputs": [
    {
      "type": "text",
      "required": false,
      "title": "text",
      "payloadName": "text",
      "multiple": false,
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ],
      "dataset": {},
      "filter": {
        "and": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "or": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "column": "text",
        "operator": "eq",
        "value": "{{user.id}}"
      },
      "helpText": "text",
      "condition": [
        {
          "when": [
            "text"
          ],
          "is": "text",
          "in": "text",
          "notIn": "text",
          "isNotEmpty": false,
          "isEmpty": false,
          "pattern": "text",
          "notMatch": false,
          "then": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          },
          "else": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          }
        }
      ],
      "sensitive": false,
      "childrenTitle": "text",
      "inputSize": {},
      "children": []
    }
  ],
  "webhookUrl": "text",
  "webhookQueryParams": "text",
  "webhookHeaders": "text",
  "webhookPayload": "text",
  "icon": "text",
  "appliesTo": [
    "service"
  ],
  "generalAccess": [
    "read"
  ]
}

Get self service action by id

GEThttps://app.configure8.io/public/v1/self-services/actions/{id}

Path parameters

id*string

Response

200400401403404500

Body

application/json

id*string

name*string

descriptionstring

type*enum

day2createdelete

status*enum

activearchiveddraft

orgId*string

createdBy*string

method*enum

webhook

createdAt*string (date-time)

updatedAtstring (date-time)

lastUsedAtstring (date-time)

inputsarray of SelfServiceActionInputSchemaDto (object)

webhookUrl*string

webhookQueryParamsstring

webhookHeadersone of

Webhook headers, can be either a string or an object

stringobject

webhookPayloadone of

Webhook payload, can be either a string or an object

stringobject

iconnullable one of

stringobjectobject

permissionsobject

appliesTonullable array of enum

generalAccessarray of enum

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/actions/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "day2",
  "status": "active",
  "orgId": "text",
  "createdBy": "text",
  "method": "webhook",
  "createdAt": "2024-12-21T15:41:45.509Z",
  "updatedAt": "2024-12-21T15:41:45.509Z",
  "lastUsedAt": "2024-12-21T15:41:45.509Z",
  "inputs": [
    {
      "type": "text",
      "required": false,
      "title": "text",
      "payloadName": "text",
      "multiple": false,
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ],
      "dataset": {},
      "filter": {
        "and": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "or": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "column": "text",
        "operator": "eq",
        "value": "{{user.id}}"
      },
      "helpText": "text",
      "condition": [
        {
          "when": [
            "text"
          ],
          "is": "text",
          "in": "text",
          "notIn": "text",
          "isNotEmpty": false,
          "isEmpty": false,
          "pattern": "text",
          "notMatch": false,
          "then": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          },
          "else": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          }
        }
      ],
      "sensitive": false,
      "childrenTitle": "text",
      "inputSize": {},
      "children": []
    }
  ],
  "webhookUrl": "text",
  "webhookQueryParams": "text",
  "webhookHeaders": "text",
  "webhookPayload": "text",
  "icon": "text",
  "appliesTo": [
    "service"
  ],
  "generalAccess": [
    "read"
  ]
}

Delete self service action and its results

DELETEhttps://app.configure8.io/public/v1/self-services/actions/{id}

Path parameters

id*string

Response

204400401403404500

Self service action deleted

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/actions/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get list of self service results

GEThttps://app.configure8.io/public/v1/self-services/results

Query parameters

Response

200400401403500

Body

application/json

items*array of ServiceActionResultsListItemDto (object)

total*number

pageSize*number

pageNumber*number

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/results', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "actionId": "text",
      "orgId": "text",
      "triggeredBy": "text",
      "status": "inprogress",
      "startedAt": "2024-12-21T15:41:45.509Z",
      "completedAt": "2024-12-21T15:41:45.509Z",
      "duration": 0,
      "action": {
        "id": "text",
        "name": "text",
        "icon": {
          "color": "text",
          "icon": "text"
        },
        "appliesTo": "application",
        "generalAccess": "read"
      },
      "user": {
        "displayName": "text",
        "photoUrl": "text"
      },
      "appliedFrom": {
        "id": "text",
        "name": "text",
        "type": "application"
      }
    }
  ],
  "total": 0,
  "pageSize": 0,
  "pageNumber": 0
}

Get self service action result token

GEThttps://app.configure8.io/public/v1/self-services/token/{id}/{resultId}

Path parameters

id*string

ssa action id

resultId*string

ssa result id

Response

200401403404406500

Body

application/json

tokenstring

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/token/{id}/{resultId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "token": "text"
}

Get self service action result details

GEThttps://app.configure8.io/public/v1/self-services/results/{id}/{resultId}

Path parameters

id*string

resultId*string

Response

200401403404500

Body

application/json

id*string

actionId*string

orgId*string

triggeredBy*string

status*enum

inprogressfailedcompleteterminatedpending-approvalrejected

startedAt*string (date-time)

completedAt*string (date-time)

duration*number

action*object

The action that was executed

user*object

The user that triggered the action

response*array of SelfServiceActionExecutionStepDto (object)

method*enum

webhook

webhookUrl*string

webhookQueryParamsstring

webhookHeadersobject

webhookPayload*object

userInputs*array of SelfServiceActionInputDto (object)

appliedFromnullable object

The entity to which the action was started from

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/results/{id}/{resultId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "actionId": "text",
  "orgId": "text",
  "triggeredBy": "text",
  "status": "inprogress",
  "startedAt": "2024-12-21T15:41:45.509Z",
  "completedAt": "2024-12-21T15:41:45.509Z",
  "duration": 0,
  "action": {
    "id": "text",
    "name": "text",
    "description": "text",
    "icon": {
      "color": "text",
      "icon": "text"
    },
    "appliesTo": "application",
    "generalAccess": "read"
  },
  "user": {
    "displayName": "text",
    "photoUrl": "text"
  },
  "response": [
    {
      "title": "text",
      "status": "inprogress",
      "startedAt": "2024-12-21T15:41:45.509Z",
      "completedAt": "2024-12-21T15:41:45.509Z",
      "logs": [
        "text"
      ]
    }
  ],
  "method": "webhook",
  "webhookUrl": "text",
  "webhookQueryParams": "text",
  "userInputs": [
    {
      "type": "text",
      "required": false,
      "title": "text",
      "payloadName": "text",
      "multiple": false,
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ],
      "dataset": {},
      "filter": {
        "and": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "or": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "column": "text",
        "operator": "eq",
        "value": "{{user.id}}"
      },
      "helpText": "text",
      "condition": [
        {
          "when": [
            "text"
          ],
          "is": "text",
          "in": "text",
          "notIn": "text",
          "isNotEmpty": false,
          "isEmpty": false,
          "pattern": "text",
          "notMatch": false,
          "then": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          },
          "else": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          }
        }
      ],
      "sensitive": false,
      "childrenTitle": "text",
      "inputSize": {},
      "children": [
        {
          "type": "text",
          "required": false,
          "title": "text",
          "payloadName": "text",
          "multiple": false,
          "options": [
            {
              "value": "text",
              "label": "text"
            }
          ],
          "dataset": {},
          "filter": {
            "and": [
              {
                "column": "owners",
                "operator": "eq",
                "value": "{{user.id}}"
              }
            ],
            "or": [
              {
                "column": "owners",
                "operator": "eq",
                "value": "{{user.id}}"
              }
            ],
            "column": "text",
            "operator": "eq",
            "value": "{{user.id}}"
          },
          "helpText": "text",
          "condition": [
            {
              "when": [
                "text"
              ],
              "is": "text",
              "in": "text",
              "notIn": "text",
              "isNotEmpty": false,
              "isEmpty": false,
              "pattern": "text",
              "notMatch": false,
              "then": {
                "required": false,
                "title": "text",
                "options": [
                  {
                    "value": "text",
                    "label": "text"
                  }
                ],
                "dataset": {},
                "helpText": "text"
              },
              "else": {
                "required": false,
                "title": "text",
                "options": [
                  {
                    "value": "text",
                    "label": "text"
                  }
                ],
                "dataset": {},
                "helpText": "text"
              }
            }
          ],
          "sensitive": false,
          "childrenTitle": "text",
          "inputSize": {},
          "children": []
        }
      ]
    }
  ],
  "appliedFrom": {
    "id": "text",
    "name": "text",
    "type": "application",
    "generalAccess": "read"
  }
}

Get self service action by id to run

GEThttps://app.configure8.io/public/v1/self-services/actions/{id}/run

Path parameters

id*string

Response

200400401403404500

Body

application/json

id*string

name*string

descriptionstring

type*enum

day2createdelete

status*enum

activearchiveddraft

orgId*string

createdBy*string

method*enum

webhook

createdAt*string (date-time)

updatedAtstring (date-time)

lastUsedAtstring (date-time)

inputsarray of SelfServiceActionInputSchemaDto (object)

webhookUrl*string

webhookQueryParamsstring

webhookHeadersone of

Webhook headers, can be either a string or an object

stringobject

webhookPayloadone of

Webhook payload, can be either a string or an object

stringobject

iconnullable one of

stringobjectobject

permissionsobject

appliesTonullable array of enum

generalAccessarray of enum

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/actions/{id}/run', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "day2",
  "status": "active",
  "orgId": "text",
  "createdBy": "text",
  "method": "webhook",
  "createdAt": "2024-12-21T15:41:45.509Z",
  "updatedAt": "2024-12-21T15:41:45.509Z",
  "lastUsedAt": "2024-12-21T15:41:45.509Z",
  "inputs": [
    {
      "type": "text",
      "required": false,
      "title": "text",
      "payloadName": "text",
      "multiple": false,
      "options": [
        {
          "value": "text",
          "label": "text"
        }
      ],
      "dataset": {},
      "filter": {
        "and": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "or": [
          {
            "column": "owners",
            "operator": "eq",
            "value": "{{user.id}}"
          }
        ],
        "column": "text",
        "operator": "eq",
        "value": "{{user.id}}"
      },
      "helpText": "text",
      "condition": [
        {
          "when": [
            "text"
          ],
          "is": "text",
          "in": "text",
          "notIn": "text",
          "isNotEmpty": false,
          "isEmpty": false,
          "pattern": "text",
          "notMatch": false,
          "then": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          },
          "else": {
            "required": false,
            "title": "text",
            "options": [
              {
                "value": "text",
                "label": "text"
              }
            ],
            "dataset": {},
            "helpText": "text"
          }
        }
      ],
      "sensitive": false,
      "childrenTitle": "text",
      "inputSize": {},
      "children": []
    }
  ],
  "webhookUrl": "text",
  "webhookQueryParams": "text",
  "webhookHeaders": "text",
  "webhookPayload": "text",
  "icon": "text",
  "appliesTo": [
    "service"
  ],
  "generalAccess": [
    "read"
  ]
}

Run self service action

POSThttps://app.configure8.io/public/v1/self-services/actions/{id}/run

Path parameters

id*string

Body

application/json

Self service action parameters for execution.

inputsarray of object

appliedFromIdstring

Id of the catalog that this action ran from

appliedFromTypestring

Type of the catalog that this action ran from

Response

400401403404500

Returned when filter is invalid

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/self-services/actions/{id}/run', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();