-
createAutomation
Creates an automation
POST /automation_catalog/automationsCreates an automation with optional description. An automation's root structure is based off the agendajs library, with any custom data falling into the 'data' array
-
deleteAutomations
Deletes automations
DELETE /automation_catalog/automationsDeletes automations (based off an array of Ids)
-
exportAutomation
Exports a single automation
GET /automation_catalog/automations/:id/exportReturns a single automation formatted for importing
-
getAutomationById
Gets an single automation by its id
GET /automation_catalog/automations/:idGets an single automation by its id
-
getAutomations
Gets all known automations
GET /automation_catalog/automationsGets all known automations returned in alphabetical order
-
importAutomations
Import automation documents
POST /automation_catalog/automations/importInsert automation documents into the automation collection from a user supplied JSON document.
-
migrateAgendaJobs
Migrate Agenda Jobs
POST /automation_catalog/automations/migrationTakes an existing Agenda Job data structure and converts it to an Automation
-
runAutomation
Single run of an automation outside its scheduled runs
POST /automation_catalog/automations/:id/runSingle run of an automation outside its scheduled runs, Requires a workflow to be attached to the automation.
-
scheduleAutomation
Updates an automation's schedule
PUT /automation_catalog/automations/:id/scheduleUpdates an automation's schedule properties (only)
-
updateAutomation
Updates an automation's attributes.
PUT /automation_catalog/automations/:idUpdates an automation's attributes (including scheduling data).
2021.2 (latest)
- API REFERENCE
- USER
- ADMIN
- DEVELOPER
- PRODUCT NOTICES