Skip to main content
POST
Create an ordinary Automation
To install and sign in to the CLI, see Call from the CLI.

Authorizations

x-coderabbitai-api-key
string
header
required

See Authentication for the key types and where to create a key.

Body

application/json
definition
object
required

Ordinary Automation definition. Uses the native trigger and destination field names. Factory assignments and UI experience settings are not accepted.

org_id
string

Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.

Minimum string length: 1
org_name
string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
message_platform_provider
enum<string>
default:slack
Available options:
slack,
discord,
microsoft_teams

Response

OK

automation_id
string
required
revision
integer
required
Required range: x > 0