Automations

Saved automations that still send when an event matches. Pause or resume one.

These routes are the public API. Send Authorization: Bearer with a workspace server API key. The key can act on every app in the workspace. A route that names an app uses that app id. environment is development or production.

GET /api/v1/public/apps/{app}/environments/{environment}/automations

The automations were listed.

Path

• app — App id in this workspace.
• environment — development or production.

Responses

• 200 AUTOMATIONS_LISTED — The automations were listed.
• 401 INVALID_API_KEY — The API key is invalid.
• 404 APP_NOT_FOUND — The app could not be found.
• 429 RATE_LIMIT_EXCEEDED — Too many requests. Please try again later.
• 500 SERVER_ERROR — Something went wrong. Please try again.

PATCH /api/v1/public/apps/{app}/environments/{environment}/automations/{automation}

The automation was updated.

Path

• app — App id in this workspace.
• environment — development or production.
• automation — Automation id.

Body

• enabled (boolean, required)

Responses

• 200 AUTOMATION_UPDATED — The automation was updated.
  • id (string, required)
  • enabled (boolean, required)
• 401 INVALID_API_KEY — The API key is invalid.
• 404 RESOURCE_NOT_FOUND — The requested resource could not be found.
• 422 VALIDATION_FAILED — The request contains invalid fields.
• 429 RATE_LIMIT_EXCEEDED — Too many requests. Please try again later.
• 500 SERVER_ERROR — Something went wrong. Please try again.