How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chatwoot Automation Rule API

Workflow automation rules

Chatwoot Automation Rule API is one of 40 APIs that Chatwoot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.1.0.

Requests are made against a single base URL, https://app.chatwoot.com/.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.0
Base URL
https://app.chatwoot.com
Authentication
API Key, API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Chatwoot Automation Rule API declares 3 security schemes for authenticating requests. An API key is passed in the header as api_access_token (userApiKey). An API key is passed in the header as api_access_token (agentBotApiKey). An API key is passed in the header as api_access_token (platformAppApiKey).

  • userApiKey — This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can…
  • agentBotApiKey — This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis.
  • platformAppApiKey — This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Automation Rule 5

Workflow automation rules

GET
/api/v1/accounts/{account_id}/automation_rules
List all automation rules in an account
get-account-automation-rule 3 params → 200403
POST
/api/v1/accounts/{account_id}/automation_rules
Add a new automation rule
add-new-automation-rule-to-account 1 param body → 200403
GET
/api/v1/accounts/{account_id}/automation_rules/{id}
Get a automation rule details
get-details-of-a-single-automation-rule 3 params → 200401404
PATCH
/api/v1/accounts/{account_id}/automation_rules/{id}
Update automation rule in Account
update-automation-rule-in-account 3 params body → 200403404
DELETE
/api/v1/accounts/{account_id}/automation_rules/{id}
Remove a automation rule from account
delete-automation-rule-from-account 3 params → 200403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are automation_rule_item (9 properties), automation_rule_create_update_payload (6 properties), request_error (3 properties), bad_request_error (2 properties). Each schema is shown below with its type and property counts.

automation_rule_item
object
9 properties
automation_rule
object
1 property
request_error
object
3 properties
automation_rule_create_update_payload
object
6 properties
bad_request_error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwoot-automation-rule-api-openapi.yml Raw ↑

Other APIs Chatwoot publishes across the network.

Chatwoot Client API
Chatwoot Platform API
Chatwoot Account AgentBots API
Chatwoot Account API
Chatwoot Account Users API
Chatwoot Accounts API
Chatwoot AgentBots API
Chatwoot Agents API
Chatwoot Audit Logs API
Chatwoot Canned Responses API
Chatwoot Contact Labels API
Chatwoot Contacts API API
Where this information came from

This is an independent, third-party profile of Chatwoot Automation Rule API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.