Ravenna

https://docs.ravenna.ai
Admin
Ravenna is an AI-powered, Slack-native service desk built for internal IT, HR, and operations teams...
Tokens:698,693
Snippets:3,538
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Host Software

Source: https://docs.ravenna.ai/integrations/fleet/workflows

Lists all software installed on a user's device with version information and vulnerability details.

```APIDOC
## Get Host Software

### Description
Lists all software installed on a user's device with version information and vulnerability details. Optionally filter to show only software with known vulnerabilities for security auditing.
```

--------------------------------

### Error Response Examples

Source: https://docs.ravenna.ai/api/status/create-a-status

Example JSON structures for common API error states.

```yaml
code: UNAUTHORIZED
message: Authorization not provided
issues: []
```

```yaml
code: FORBIDDEN
message: Insufficient access
issues: []
```

```yaml
code: INTERNAL_SERVER_ERROR
message: Internal server error
issues: []
```

--------------------------------

### Bad Request Error Example

Source: https://docs.ravenna.ai/api/workspace/updates-a-workspaces

Example structure for a 400 Bad Request error response.

```yaml
error.BAD_REQUEST:
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
      type: object
```

--------------------------------

### Usage examples for /help and /support shortcuts

Source: https://docs.ravenna.ai/integrations/slack/slash-commands

These commands trigger the ticket creation flow or create a ticket with a description. They support the same subcommands as the primary /rav command.

```text
/help
/help I can't access Salesforce
/help create
/support
/support my laptop won't connect to Wi-Fi
/support mine
```

--------------------------------

### @Get Device Apps

Source: https://docs.ravenna.ai/integrations/intune/agent-tools

Retrieves detected applications installed on a specific Intune managed device.

```APIDOC
## @Get Device Apps

### Description
Retrieves detected applications installed on a specific Intune managed device. Requires a device ID obtained from the Find Devices tool.

### Input Fields
- **Intune managed device ID** (string) - Required
- **App name filter** (string) - Optional
- **Platform filter** (string) - Optional
- **Publisher filter** (string) - Optional

### Output Data
- **Application name** (string)
- **Version** (string)
- **Publisher** (string)
- **Platform** (string)
- **App ID** (string)
```

--------------------------------

### Access Help Menu via Slack

Source: https://docs.ravenna.ai/integrations/slack/slash-commands

Use this command to trigger an interactive help menu containing quick actions and documentation links.

```text
/rav help
```

--------------------------------

### Error Property Examples

Source: https://docs.ravenna.ai/api/request-types/get-request-type-by-id

Examples for individual error object properties.

```json
example: Invalid input data
```

```json
example: BAD_REQUEST
```

--------------------------------

### List Resource JSON Response

Source: https://docs.ravenna.ai/api/overview

Example of a successful response body returning an array of resources.

```json
[
  { "id": "123", "name": "Support Queue", "status": "active" },
  { "id": "124", "name": "Billing Queue", "status": "active" }
]
```

--------------------------------

### Error Schema Examples

Source: https://docs.ravenna.ai/api/foundry/delete-a-foundry-action

Example structures for common API error responses.

```json
example:
  code: BAD_REQUEST
  message: Invalid input data
  issues: []
```

```json
example:
  code: UNAUTHORIZED
  message: Authorization not provided
  issues: []
```

--------------------------------

### Unauthorized Error Example

Source: https://docs.ravenna.ai/api/access-level/update-a-single-access-level-by-id

Example structure for a 401 Unauthorized error response.

```json
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
```

--------------------------------

### POST /ai-brief-schedules

Source: https://docs.ravenna.ai/api/ai-brief-schedule/create-ai-brief-schedule

Creates a new AI brief schedule configuration.

```APIDOC
## POST /ai-brief-schedules

### Description
Creates a new AI brief schedule for a dashboard, specifying the cadence, delivery channels, and timing.

### Method
POST

### Endpoint
/ai-brief-schedules

### Request Body
- **dashboardId** (string) - Required - The ID of the dashboard.
- **cadence** (string) - Required - The frequency of the schedule (daily, weekly, monthly).
- **slackChannelIds** (array) - Required - List of Slack channel IDs for delivery.
- **time** (string) - Required - The time of day in HH:MM format.
- **day** (integer) - Optional - The day of the month (0-31).
- **prompt** (string|null) - Optional - Custom prompt for the AI brief.
- **userId** (string) - Optional - The ID of the user associated with the schedule.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the schedule.
- **dashboardId** (string) - The dashboard ID.
- **workspaceId** (string) - The workspace ID.
- **organizationId** (string) - The organization ID.
- **userId** (string|null) - The user ID.
- **cadence** (string) - The frequency.
- **slackChannelIds** (array) - List of Slack channel IDs.
- **time** (string) - The scheduled time.
- **day** (number|null) - The scheduled day.
- **prompt** (string|null) - The AI prompt.
- **scheduleId** (string|null) - The internal schedule ID.
- **isActive** (boolean) - Whether the schedule is active.
- **lastRunAt** (string|null) - Timestamp of the last run.
- **nextScheduledAt** (string|null) - Timestamp of the next run.
- **createdAt** (string) - Creation timestamp.
- **updatedAt** (string) - Last update timestamp.
```

--------------------------------

### UNAUTHORIZED Error Schema Example

Source: https://docs.ravenna.ai/api/workspace-custom-fields/update-a-ticket-attribute-eg-reorder

Example structure for a 401 Unauthorized error response.

```json
{
  "code": "UNAUTHORIZED"
}
```

--------------------------------

### Create Workspace Forms

Source: https://docs.ravenna.ai/documentation/automate/copilot/configure-workspace

Use these prompts to initialize new request forms within specific channels or with custom descriptions.

```text
Add a form called "Laptop Request" to the IT Support channel
```

```text
Create a form called "PTO Request" with the description "Submit a time-off request for approval"
```

--------------------------------

### POST /queues

Source: https://docs.ravenna.ai/api/channels/create-a-new-channel

Creates a new channel in the system.

```APIDOC
## POST /queues

### Description
Creates a new channel. This endpoint requires a name and an emoji to be provided in the request body.

### Method
POST

### Endpoint
/queues

### Request Body
- **id** (string) - Optional - Unique identifier for the channel.
- **name** (string) - Required - The name of the channel.
- **prefix** (string) - Optional - A prefix for the channel (1-10 characters, must start with uppercase letter).
- **emoji** (string) - Required - The emoji associated with the channel.
- **requestChannelId** (string) - Optional - ID of the request channel.
- **triageChannelId** (string) - Optional - ID of the triage channel.
- **workspaceId** (string) - Optional - ID of the workspace.

### Response
#### Success Response (200)
- **id** (string) - The ID of the created channel.
- **name** (string) - The name of the channel.
- **workspaceId** (string) - The ID of the workspace.
- **workspace** (object) - Workspace details.
- **prefix** (string) - The channel prefix.
- **emoji** (string) - The channel emoji.
- **type** (string) - The channel type (DEFAULT, PORTAL, DM).
- **system** (boolean) - Whether it is a system channel.
- **settings** (object) - Channel configuration settings.
```

--------------------------------

### Error Response Examples

Source: https://docs.ravenna.ai/api/business-schedule/get-business-schedule-by-id

Example JSON structures for common API error responses.

```yaml
code: FORBIDDEN
message: Insufficient access
issues: []
```

```yaml
code: NOT_FOUND
message: Not found
issues: []
```

```yaml
code: INTERNAL_SERVER_ERROR
message: Internal server error
issues: []
```

--------------------------------

### POST /applications

Source: https://docs.ravenna.ai/api/application/create-a-new-application

Creates a new application within the Ravenna system.

```APIDOC
## POST /applications

### Description
Create a new application by providing the necessary configuration details.

### Method
POST

### Endpoint
/applications

### Request Body
- **name** (string|null) - Optional - Name of the application
- **domain** (string|null) - Optional - Domain associated with the application
- **price** (number|null) - Optional - Price of the application
- **imageUrl** (string|null) - Optional - URL for the application image
- **details** (string|null) - Optional - Additional details
- **ownerId** (string|null) - Optional - ID of the owner
- **approverId** (string|null) - Optional - ID of the approver
- **ownerGroupId** (string|null) - Optional - ID of the owner group
- **approverGroupId** (string|null) - Optional - ID of the approver group
- **approvers** (array) - Optional - List of approvers with their IDs
- **approverGroups** (array) - Optional - List of approver groups with their IDs
- **postProvisioningMessage** (string|null) - Optional - Message displayed after provisioning
- **assignmentStrategy** (string) - Optional - Strategy: AutoApprove, RoundRobin, or All
- **provisioningMethod** (string) - Required - Method: group, application, workflow, or manual
- **workspaces** (array) - Optional - List of workspaces with their IDs

### Response
#### Success Response (200)
- **id** (string) - Application ID
- **name** (string|null) - Application name
- **displayName** (string|null) - Display name
- **domain** (string|null) - Domain
- **imageUrl** (string|null) - Image URL
- **price** (number|null) - Price
- **status** (string) - Status: ACTIVE, INACTIVE, or DELETED
- **provisioningMethod** (string|null) - Provisioning method used
- **details** (string|null) - Details
- **postProvisioningMessage** (string|null) - Post provisioning message
- **ownerId** (string|null) - Owner ID
```

--------------------------------

### Configure Allowlisted Domains

Source: https://docs.ravenna.ai/integrations/email/overview

Example entries for domains permitted to create tickets, including all subdomains.

```text
partnercompany.com
customerdomain.org
```

--------------------------------

### Bad Request Error Example

Source: https://docs.ravenna.ai/api/access-policy/get-an-access-policy

Example payload for a 400 Bad Request error.

```yaml
example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
```

--------------------------------

### Configure Blocked Domains

Source: https://docs.ravenna.ai/integrations/email/overview

Example entries for domains that are always rejected.

```text
spam.com
bulk-mailer.net
```

--------------------------------

### POST /webauthn/authentication-options

Source: https://docs.ravenna.ai/api/webauthn/generate-webauthn-authentication-options

Generates the necessary options to initiate a WebAuthn authentication process.

```APIDOC
## POST /webauthn/authentication-options

### Description
Generates WebAuthn authentication options required to proceed with user authentication.

### Method
POST

### Endpoint
/webauthn/authentication-options

### Request Body
- **body** (object) - Required - An empty object is expected.

### Response
#### Success Response (200)
- **response** (object) - Successful response containing authentication options.

#### Error Responses
- **400** - Invalid input data
- **401** - Authorization not provided
- **403** - Insufficient access
- **500** - Internal server error
```

--------------------------------

### Error Response Examples

Source: https://docs.ravenna.ai/api/ticket-message/delete-a-ticket-message

Examples of error response objects for various HTTP status codes.

```json
example:
  code: BAD_REQUEST
  message: Invalid input data
  issues: []
```

```json
example:
  code: UNAUTHORIZED
  message: Authorization not provided
  issues: []
```

```json
example: Invalid input data
```

```json
example: BAD_REQUEST
```

```json
example: []
```

```json
example: Authorization not provided
```

--------------------------------

### Error Response Schema Example

Source: https://docs.ravenna.ai/api/teams-conversation/get-teams-message-and-channel-info-by-channel-id-%2B-message-id

Example structure for a 400 Bad Request error response.

```json
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data"
}
```

--------------------------------

### POST /foundry/integrations

Source: https://docs.ravenna.ai/api/foundry/create-a-foundry-integration

Creates a new Foundry integration in the Ravenna system.

```APIDOC
## POST /foundry/integrations

### Description
Creates a new Foundry integration with the specified configuration, including authentication details and documentation URLs.

### Method
POST

### Endpoint
/foundry/integrations

### Request Body
- **apiName** (string) - Required - The name of the API.
- **description** (string|null) - Optional - A description of the integration.
- **docsUrl** (string) - Required - The URL to the integration documentation.
- **baseUrl** (string) - Optional - The base URL for the API.
- **authType** (string) - Required - The authentication type (NONE, API_KEY, OAUTH2, BEARER, BASIC).
- **authConfig** (object) - Optional - Configuration object for authentication.
- **workflowGroup** (string) - Optional - The workflow group associated with the integration.
- **defaultHeaders** (object) - Optional - Default headers for requests.
- **context7LibraryId** (string) - Optional - The ID of the context library.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created integration.
- **apiName** (string) - The name of the API.
- **description** (string|null) - The description of the integration.
- **docsUrl** (string) - The documentation URL.
- **baseUrl** (string|null) - The base URL.
- **authType** (string) - The authentication type used.
- **maskedAuthConfig** (object) - Masked authentication configuration details.
- **docsValidationStatus** (string) - The status of the documentation validation.
- **docsValidationResult** (object) - The result of the documentation validation.
- **docsValidationProgress** (object) - Progress details of the validation process.
```

--------------------------------

### Error Response Examples

Source: https://docs.ravenna.ai/api/channels/get-channel-by-id

Examples of JSON error responses for common HTTP status codes.

```json
example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
```

```json
example: Invalid input data
```

```json
example: BAD_REQUEST
```

```json
example: []
```

```json
example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
```

```json
example: Authorization not provided
```

```json
example: UNAUTHORIZED
```

```json
example: []
```

--------------------------------

### Exact syntax slash commands

Source: https://docs.ravenna.ai/integrations/slack/slash-commands

Use specific command keywords for faster execution of Ravenna tasks.

```text
/rav mine
/rav create
/rav assign BUGZ-123
/rav status 456
/rav resolve SUPP-789
/rav connect
```

--------------------------------

### Error Response Schema Example

Source: https://docs.ravenna.ai/api/agents/bulk-delete-agents

Example structure for a 400 Bad Request error response.

```json
example:
  code: BAD_REQUEST
  message: Invalid input data
  issues: []
```

--------------------------------

### Configure Allowlisted Emails

Source: https://docs.ravenna.ai/integrations/email/overview

Example entries for individual guest email addresses permitted to create tickets.

```text
partner@vendor.com
consultant@external.org
```

--------------------------------

### GET /workflow-config/apps

Source: https://docs.ravenna.ai/api/workflow/list-apps-with-actions

Retrieves a list of all applications configured within the system, including their available actions and input specifications.

```APIDOC
## GET /workflow-config/apps

### Description
Retrieves a list of all applications configured within the system, including their available actions and input specifications.

### Method
GET

### Endpoint
/workflow-config/apps

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the app.
- **name** (string) - The name of the app.
- **group** (string) - The group the app belongs to.
- **icon** (string) - The icon associated with the app.
- **actions** (array) - A list of actions, activities, conditionals, or triggers available for this app.
```

--------------------------------

### Define Error Schema Examples

Source: https://docs.ravenna.ai/api/rules/list-rules-attached-to-an-agent

These examples represent the JSON structure for various API error responses.

```yaml
example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
```

```yaml
example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
```

```yaml
example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
```

```yaml
example:
        code: NOT_FOUND
        message: Not found
        issues: []
```

```yaml
example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
```

--------------------------------

### Bad Request Error Schema Example

Source: https://docs.ravenna.ai/api/request-type-custom-fields/create-a-new-request-type-custom-field

Example structure for a 400 Bad Request error response.

```json
{
  "code": "BAD_REQUEST"
}
```

--------------------------------

### Slack Integration Commands and UI Elements

Source: https://docs.ravenna.ai/guides/day-one/set-up-triage-channel

Commands and UI labels used during the Slack channel setup process.

```text
/invite @Ravenna
```

```text
Connect Agent Channel
```

```text
Save
```

```text
#it-support
```

--------------------------------

### DocuSign Demo Environment URLs

Source: https://docs.ravenna.ai/guides/how-to/foundry/setup-oauth/docusign

Alternative URLs for testing integrations in the DocuSign demo environment.

```text
Authorization URL: https://account-d.docusign.com/oauth/auth
Token URL: https://account-d.docusign.com/oauth/token
Base URL: https://demo.docusign.net/restapi
```

--------------------------------

### OpenAPI Error Object Examples

Source: https://docs.ravenna.ai/api/foundry/run-a-test-execution-for-a-foundry-action

Examples of error response objects for different HTTP status codes.

```yaml
example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
```

```yaml
example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
```

```yaml
example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
```

--------------------------------

### Error Response Schema Examples

Source: https://docs.ravenna.ai/api/foundry/delete-a-foundry-integration

Examples of error response objects returned by the API when a request fails.

```json
example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
```

```json
example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
```
Tokens:
Raw