Skip to main content
POST
Create an on-demand or scheduled report

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Body

application/json
name
string
required
time
string
required
timezone
string
required
parameters
object[]
required
emails
string<email>[]
required
promptTemplate
enum<string>
required
Available options:
Daily Standup Report,
Sprint Report,
Release Notes,
Organization Stats,
Custom
type
enum<string>
required
Available options:
ONDEMAND
from
string
required
Maximum string length: 255
to
string
required
Maximum string length: 255
org_id
string
Minimum string length: 1
group
enum<string>
Available options:
NONE,
REPOSITORY,
LABEL,
TEAM,
USER,
SOURCEBRANCH,
TARGETBRANCH,
STATE
subgroup
enum<string>
Available options:
NONE,
REPOSITORY,
LABEL,
TEAM,
USER,
SOURCEBRANCH,
TARGETBRANCH,
STATE
platform
enum<string>
Available options:
SLACK,
DISCORD,
EMAIL,
TEAMS
channel
string
prompt
string

Response

OK

report_id
string
required