Automations

26 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List automations for a space#

GET/automationsToken

Returns all automations in the given space. Pass `archived=true` to retrieve archived automations only. Requires `can_view_automations` space permission.

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Query	`string`	Space UUID
`archived`	Query	`boolean`	Return archived automations (default: false)

Antworten

200Array of automations
400spaceId query param required
401Not authenticated
403Insufficient space permissions

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a new automation#

POST/automationsToken

Creates a draft automation in the given space. Requires `can_create_automations` space permission.

Request-Body`application/jsonCreateAutomationDto`

Name	Typ	Beschreibung
`space_id`Pflicht	`string`	Space ID the automation belongs to
`name`Pflicht	`string`	Automation name
`description`	`string`	Automation description
`icon`	`string`	Icon identifier

Antworten

201Automation created
400Validation error
401Not authenticated
403Insufficient space permissions

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"space_id":"…","name":"…"}'

Get automation by ID#

GET/automations/{id}Token

Returns a single automation including its current status, webhook token, and published version reference.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID
`spaceId`	Query	`string`	Space UUID (optional context)

Antworten

200Automation details
400spaceId does not match this automation
401Not authenticated
404Automation not found

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update automation metadata#

PUT/automations/{id}Token

Updates name, description, icon, or webhook rate limits. Does not affect the published version or status.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Request-Body`application/jsonUpdateAutomationDto`

Name	Typ	Beschreibung
`name`	`string`	–
`description`	`string`	–
`icon`	`string`	–
`webhook_rate_limit_per_sec`	`number`	–
`webhook_rate_limit_per_hour`	`number`	–
`max_concurrent_runs`	`object`	–
`webhook_signature_scheme`	`string`	Werte: `hmac-sha256none`

Antworten

200Updated automation
400Validation error
401Not authenticated
404Automation not found

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/automations/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":"…","icon":"…"}'

Archive automation (soft delete)#

DELETE/automations/{id}Token

Marks the automation as archived (`is_archived=true`). Archived automations are hidden from the default list but can be retrieved with `?archived=true`. Use POST /:id/restore to unarchive.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Antworten

204Automation archived — no body returned
401Not authenticated
404Automation not found

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/automations/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get run analytics for an automation (last 30 days)#

GET/automations/{id}/analyticsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID
`days`	Query	`string`	Number of days back (default 30)
`startDate`	Query	`string`	ISO date string start (overrides days)
`endDate`	Query	`string`	ISO date string end (default today)
`spaceId`	Query	`any`	–

Antworten

200Analytics payload

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/{id}/analytics" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Clone an automation#

POST/automations/{id}/cloneToken

Creates a copy of the automation named `{original name} (copy)`. If the source has a draft version, it is also cloned into the new automation. The clone starts in `draft` status.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID to clone

Antworten

201Cloned automation
401Not authenticated
404Source automation not found

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/clone" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Pause a published automation#

POST/automations/{id}/pauseToken

Sets automation status to `paused`. Stops all future trigger executions (webhook deliveries and cron schedules). The automation can be resumed with POST /:id/resume.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Antworten

200Automation with status=paused
401Not authenticated
404Automation not found

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/pause" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Permanently delete an automation#

DELETE/automations/{id}/permanentToken

Hard-deletes the automation and all related data (versions, runs, steps, subscriptions, schedules). Allowed from any state. This action is irreversible.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Antworten

204Automation permanently deleted
401Not authenticated
404Automation not found

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/automations/{id}/permanent" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List users with explicit access to this automation#

GET/automations/{id}/permissionsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/{id}/permissions" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Grant a user access to this automation#

POST/automations/{id}/permissionsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/permissions" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Revoke a user's access to this automation#

DELETE/automations/{id}/permissions/{permId}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID
`permId`Pflicht	Pfad	`string`	Permission row UUID

Antworten

204Kein Inhalt

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/automations/{id}/permissions/{permId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Publish the current draft version#

POST/automations/{id}/publishToken

Validates the draft definition (must have at least one trigger node), marks it as the published version, and sets automation status to `published`. For `webhook.received` triggers: generates a unique `webhook_token` if not already set. For `schedule.cron` triggers: creates or updates the automation schedule with the computed next run time.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Antworten

200Published automation with updated status and version
400No nodes, or no trigger node in definition
401Not authenticated
404Automation or draft not found

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/publish" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Restore (unarchive) an automation#

POST/automations/{id}/restoreToken

Sets `is_archived=false` on the automation, making it visible in the default list again. The automation status is unchanged.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Antworten

200`{ id }` of the restored automation
401Not authenticated
404Automation not found

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/restore" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Resume a paused automation#

POST/automations/{id}/resumeToken

Sets automation status back to `published`. Only works when the current status is `paused`. Returns 400 if the automation is not currently paused.

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Antworten

200Automation with status=published
400Automation is not currently paused
401Not authenticated
404Automation not found

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/resume" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Save the current automation draft as a reusable template#

POST/automations/{id}/save-as-templateToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Automation UUID

Request-Body`application/jsonSaveAsTemplateDto`

Name	Typ	Beschreibung
`spaceId`Pflicht	`string`	Space UUID to save the template into
`name`	`string`	Template name — defaults to the trigger kind if omitted
`description`	`string`	–
`category`	`string`	Werte: `notificationsschedulingintegrationsinternal` Standard: `"internal"`
`tags`	`string[]`	–
`icon`	`string`	Standard: `"bx-bolt-circle"`
`svg_icon`	`string`	–
`color`	`string`	–
`is_public`	`boolean`	Standard: `false`

Antworten

201Created template
400No draft version found

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/save-as-template" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"…"}'

Get available action nodes catalog#

GET/automations/actions/catalogToken

Returns all available automation action node definitions including their config schemas, output schemas, and connection requirements. Used by the automation editor to render the node palette and configuration forms. Requires `can_view_automations` space permission.

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Query	`string`	Space UUID

Antworten

200Array of action node definitions
400spaceId is required
401Not authenticated
403Insufficient space permissions

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/actions/catalog" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get space-level automation config#

GET/automations/space-configToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Query	`string`	Space UUID

Antworten

200Space automation config
404Space not found

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/space-config" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update space-level automation config#

PATCH/automations/space-configToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Query	`any`	Space UUID

Request-Body`application/jsonUpdateSpaceConfigDto`

Name	Typ	Beschreibung
`spaceId`Pflicht	`string`	Space UUID
`max_concurrent_runs`	`object`	Maximum concurrent automation runs for this space. null or omitted = unlimited.

Antworten

200Updated space automation config
404Space not found

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/automations/space-config" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"…"}'

List automation templates#

GET/automations/templatesToken

Returns system templates merged with any custom templates saved for the space. Custom templates with the same ID take precedence.

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Query	`string`	Space UUID

Antworten

200Array of automation templates
400spaceId query param required
401Not authenticated
403Insufficient space permissions

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/templates" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a custom automation template directly#

POST/automations/templatesToken

Creates a template from scratch without needing an existing automation draft. Use POST /:id/save-as-template to create from an existing automation.

Request-Body`application/jsonCreateTemplateDto`

Name	Typ	Beschreibung
`spaceId`Pflicht	`string`	Space UUID
`name`Pflicht	`string`	Template name (1–200 chars)
`description`	`string`	–
`category`	`string`	Werte: `notificationsschedulingintegrationsinternal` Standard: `"internal"`
`tags`	`string[]`	–
`icon`	`string`	Standard: `"bx-bolt-circle"`
`svg_icon`	`string`	–
`color`	`string`	–
`trigger_kind`Pflicht	`string`	Trigger event kind (e.g. app.task.created)
`trigger_config`	`object`	Trigger configuration JSON — defaults to {}
`definition`	`object`	Automation definition with nodes and edges arrays — defaults to empty canvas
`is_public`	`boolean`	Standard: `false`

Antworten

201Created template
400Validation error
401Not authenticated
403Insufficient space permissions

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/templates" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"…","name":"…","trigger_kind":"…"}'

Get a single automation template by ID#

GET/automations/templates/{templateId}Token

Parameter

Name	Ort	Typ	Beschreibung
`templateId`Pflicht	Pfad	`string`	Template UUID
`spaceId`Pflicht	Query	`string`	Space UUID

Antworten

200Template details
400spaceId query param required
401Not authenticated
403Insufficient space permissions
404Template not found

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/templates/{templateId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a custom automation template#

PUT/automations/templates/{templateId}Token

Parameter

Name	Ort	Typ	Beschreibung
`templateId`Pflicht	Pfad	`string`	Template UUID

Request-Body`application/jsonUpdateTemplateDto`

Name	Typ	Beschreibung
`spaceId`Pflicht	`string`	Space UUID
`name`	`string`	–
`description`	`string`	–
`category`	`string`	Werte: `notificationsschedulingintegrationsinternal`
`tags`	`string[]`	–
`icon`	`string`	–
`svg_icon`	`string`	–
`color`	`string`	–
`is_public`	`boolean`	–
`definition`	`object`	Updated workflow definition (nodes + edges)

Antworten

200Updated template
400Validation error
401Not authenticated
403Insufficient space permissions
404Template not found

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/automations/templates/{templateId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"…"}'

Delete a custom automation template#

DELETE/automations/templates/{templateId}Token

Parameter

Name	Ort	Typ	Beschreibung
`templateId`Pflicht	Pfad	`string`	Template UUID
`spaceId`Pflicht	Query	`string`	Space UUID

Antworten

204Deleted
400spaceId query param required
401Not authenticated
403Insufficient space permissions
404Template not found

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/automations/templates/{templateId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List public marketplace templates#

GET/automations/templates/marketplaceToken

Returns all public templates shared by other spaces. Excludes templates from the caller's own space.

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Query	`string`	Space UUID

Antworten

200Array of public automation templates
400spaceId query param required
401Not authenticated
403Insufficient space permissions

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/templates/marketplace" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get available trigger nodes catalog#

GET/automations/triggers/catalogToken

Returns all available automation trigger node definitions including their config schemas and output schemas. Used by the automation editor to render the trigger node palette and provide {{ trigger.* }} template variable autocomplete. Requires `can_view_automations` space permission.

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Query	`string`	Space UUID

Antworten

200Array of trigger node definitions
400spaceId is required
401Not authenticated
403Insufficient space permissions

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/triggers/catalog" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Automations

List automations for a space#

Parameter

Antworten

Create a new automation#

Request-Bodyapplication/jsonCreateAutomationDto

Antworten

Get automation by ID#

Parameter

Antworten

Update automation metadata#

Parameter

Request-Bodyapplication/jsonUpdateAutomationDto

Antworten

Archive automation (soft delete)#

Parameter

Antworten

Get run analytics for an automation (last 30 days)#

Parameter

Antworten

Clone an automation#

Parameter

Antworten

Pause a published automation#

Parameter

Antworten

Permanently delete an automation#

Parameter

Antworten

List users with explicit access to this automation#

Parameter

Antworten

Grant a user access to this automation#

Parameter

Antworten

Revoke a user's access to this automation#

Parameter

Antworten

Publish the current draft version#

Parameter

Antworten

Restore (unarchive) an automation#

Parameter

Antworten

Resume a paused automation#

Parameter

Antworten

Save the current automation draft as a reusable template#

Parameter

Request-Bodyapplication/jsonSaveAsTemplateDto

Antworten

Get available action nodes catalog#

Parameter

Antworten

Get space-level automation config#

Parameter

Antworten

Update space-level automation config#

Parameter

Request-Bodyapplication/jsonUpdateSpaceConfigDto

Antworten

List automation templates#

Parameter

Antworten

Create a custom automation template directly#

Request-Bodyapplication/jsonCreateTemplateDto

Antworten

Get a single automation template by ID#

Parameter

Antworten

Update a custom automation template#

Parameter

Request-Bodyapplication/jsonUpdateTemplateDto

Antworten

Delete a custom automation template#

Parameter

Antworten

List public marketplace templates#

Parameter

Antworten

Request-Body`application/jsonCreateAutomationDto`

Request-Body`application/jsonUpdateAutomationDto`

Request-Body`application/jsonSaveAsTemplateDto`

Request-Body`application/jsonUpdateSpaceConfigDto`

Request-Body`application/jsonCreateTemplateDto`

Request-Body`application/jsonUpdateTemplateDto`