OpenAPI Specification
openapi: 3.0.1
info:
title: Elementum Access Token Automations API
description: Manage access tokens using OAuth 2.0 standards
contact:
email: apiteam@elementum.io
version: 0.0.1
servers:
- url: /v1
tags:
- name: Automations
description: Manage automations
paths:
/{recordType}/{alias}/automations:
get:
tags:
- Automations
summary: List automations under an app or element
operationId: listAutomations
parameters:
- $ref: '#/components/parameters/recordType'
- $ref: '#/components/parameters/alias'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
security:
- ClientCredentials: []
x-codegen-request-body-name: body
post:
tags:
- Automations
summary: Create an automation under an app or element
operationId: createAutomation
parameters:
- $ref: '#/components/parameters/recordType'
- $ref: '#/components/parameters/alias'
requestBody:
description: Free-form JSON payload forwarded to the downstream service
content:
application/json:
schema:
$ref: '#/components/schemas/PassthroughObject'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/PassthroughObject'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
security:
- ClientCredentials: []
x-codegen-request-body-name: body
/{recordType}/{alias}/automations/validate:
post:
tags:
- Automations
summary: Validate an automation definition without creating it
operationId: validateAutomation
parameters:
- $ref: '#/components/parameters/recordType'
- $ref: '#/components/parameters/alias'
requestBody:
description: Free-form JSON payload forwarded to the downstream service
content:
application/json:
schema:
$ref: '#/components/schemas/PassthroughObject'
required: true
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/PassthroughObject'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
security:
- ClientCredentials: []
x-codegen-request-body-name: body
/{recordType}/{alias}/automations/{id}:
get:
tags:
- Automations
summary: Get an automation by ID
operationId: getAutomation
parameters:
- $ref: '#/components/parameters/recordType'
- $ref: '#/components/parameters/alias'
- $ref: '#/components/parameters/passthroughId'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
security:
- ClientCredentials: []
x-codegen-request-body-name: body
put:
tags:
- Automations
summary: Update an automation by ID
operationId: updateAutomation
parameters:
- $ref: '#/components/parameters/recordType'
- $ref: '#/components/parameters/alias'
- $ref: '#/components/parameters/passthroughId'
requestBody:
description: Free-form JSON payload forwarded to the downstream service
content:
application/json:
schema:
$ref: '#/components/schemas/PassthroughObject'
required: true
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/PassthroughObject'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
security:
- ClientCredentials: []
x-codegen-request-body-name: body
delete:
tags:
- Automations
summary: Delete an automation by ID
operationId: deleteAutomation
parameters:
- $ref: '#/components/parameters/recordType'
- $ref: '#/components/parameters/alias'
- $ref: '#/components/parameters/passthroughId'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/PassthroughObject'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
security:
- ClientCredentials: []
x-codegen-request-body-name: body
components:
schemas:
AutomationList:
type: array
description: An automation's active and/or draft workflow, each in full-state form (with triggers, tasks, and output properties).
items:
$ref: '#/components/schemas/PassthroughObject'
PassthroughObject:
type: object
additionalProperties: true
description: Free-form JSON object forwarded to/from the downstream service.
parameters:
recordType:
name: recordType
in: path
description: '''apps'', ''elements'', ''tasks'', or ''transactions'''
required: true
schema:
type: string
format: string
passthroughId:
name: id
in: path
description: The resource ID
required: true
schema:
type: string
format: string
alias:
name: alias
in: path
description: The app's namespace or its UUID
required: true
schema:
type: string
format: string
responses:
'422':
description: Unprocessable Entity
'404':
description: Not Found
'400':
description: Bad Request
'403':
description: Forbidden
'401':
description: Unauthorized
'500':
description: Internal Server Error
'429':
description: Too Many Requests
securitySchemes:
ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: /oauth/token
externalDocs:
description: Find out more about Elementum
url: https://www.elementum.com/