Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

contentstack Automations API

Automations are individual workflow definitions that connect triggers (such as Contentstack content events) to actions (such as sending notifications or updating external systems).

contentstack Automations API is one of 45 APIs that contentstack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Automations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 3 base URLs: https://api.contentstack.io, https://eu-api.contentstack.com, https://au-api.contentstack.com.

4 operations 4 paths 3 schemas 2 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://cdn.contentstack.io
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

contentstack Automations API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as authtoken (authtokenAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token (M2M) with analytics access.
  • authtokenAuth — Contentstack user authtoken. Only organization Owners and Admins can access analytics.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Automations 4

Automations are individual workflow definitions that connect triggers (such as Contentstack content events) to actions (such as sending notifications or updating external systems).

GET
/v1/organizations/{organization_uid}/projects/{project_uid}/automations
Get all automations
getAllAutomations 2 params → 200401
GET
/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}
Get an automation
getAutomation 3 params → 200401404
PUT
/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}/activate
Activate an automation
activateAutomation 3 params → 200400401
PUT
/v1/organizations/{organization_uid}/projects/{project_uid}/automations/{automation_uid}/deactivate
Deactivate an automation
deactivateAutomation 3 params → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Automation (7 properties), Error (2 properties), AutomationList (1 property). Each schema is shown below with its type and property counts.

AutomationList
object
A list of automations in a project.
1 property
Automation
object
An automation workflow that connects a trigger to one or more actions.
7 properties
Error
object
Standard error response.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

contentstack-automations-api-openapi.yml Raw ↑

Other APIs contentstack publishes across the network.

Contentstack GraphQL Content Delivery API
Contentstack Image Delivery API
Contentstack Analytics API
Contentstack Knowledge Vault API
Contentstack Generative AI API
contentstack Accounts API
contentstack Assets API
contentstack Attributes API
contentstack Audiences API
contentstack Audit Logs API
contentstack Brand Kits API
contentstack Cache Analytics API