### Basic Install Handler Example Source: https://developer.rocketlane.com/v1.3/docs/app-set-up-events-1 A JavaScript example demonstrating how to implement the `onAppInstall` event handler. It logs the installation ID using the provided runtime context and shows where to add logic for webhook registration or configuration storage. ```javascript eventHandlers: { onAppInstall: { run: async (r, args) => { const { installationId, config, context } = args; r.log.info(`Installed app with ID: ${installationId}`); // You could register a webhook here // or store config values in Rocketlane's storage } } } ``` -------------------------------- ### Rocketlane App Lifecycle Event Handlers Example Source: https://developer.rocketlane.com/v1.3/docs/app-lifecycle-methods-1 An example demonstrating how to implement `onAppInstall` and `onAppUninstall` event handlers in a Rocketlane application. It includes logging the installation ID and placeholder comments for setup and cleanup logic. ```JavaScript eventHandlers: { onAppInstall: { run: async (r, args) => { const { installationId, config, context } = args; console.log("App installed:", installationId); // Setup logic goes here } }, onAppUninstall: { run: (r, args) => { const { installationId, context } = args; console.log("App uninstalled:", installationId); // Cleanup logic goes here } } } ``` -------------------------------- ### Basic Install Handler Example Source: https://developer.rocketlane.com/v1.3/docs/back-end-capabilities A JavaScript example demonstrating how to implement the `onAppInstall` event handler. It logs the installation ID using the provided runtime context and shows where to add logic for webhook registration or configuration storage. ```javascript eventHandlers: { onAppInstall: { run: async (r, args) => { const { installationId, config, context } = args; r.log.info(`Installed app with ID: ${installationId}`); // You could register a webhook here // or store config values in Rocketlane's storage } } } ``` -------------------------------- ### Rocketlane CLI Installation and Usage Source: https://developer.rocketlane.com/v1.3/docs/front-end-apps-copy-1 This section covers the installation of the Rocketlane CLI globally using npm, and provides essential commands for initializing a new app, starting a local development server, building the app, and deploying it to the Rocketlane Marketplace. ```bash npm install -g @rocketlane/rli ``` ```bash rli init my-rocketlane-app ``` ```bash cd my-rocketlane-app rli dev ``` ```bash rli build rli deploy ``` -------------------------------- ### Rocketlane API Documentation Categories Source: https://developer.rocketlane.com/v1.3/docs/getting-started Outlines the three main categories of API documentation available: Guides for context and tutorials, API reference for objects and schemas, and Recipes for practical implementation examples. ```APIDOC API Documentation Structure: - Guides: API usage context, guides, and tutorials. - API reference: Comprehensive reference for objects, schemas, and endpoints. - Recipes: Practical manuals with syntax, parameters, and expected outcomes for specific API operations. ``` -------------------------------- ### Rocketlane App Set-up Event Handlers Source: https://developer.rocketlane.com/v1.3/docs/app-set-up-events-1 Defines the structure for handling application setup events in Rocketlane. It includes parameters for the runtime context and event-specific arguments, and outlines the use cases for installation, uninstallation, and custom events. ```APIDOC Parameters: r: Rocketlane runtime context (includes logging, storage, HTTP clients). args: Event-specific data (installationId, user context, config values, etc.). Supported Set-up Events: 1. onAppInstall: Description: Runs automatically when your app is installed. Use cases: Initialize app configurations, register webhooks, create system resources, log installation. 2. onAppUninstall: Description: Runs automatically when a user removes your app. Use cases: Clean up storage/credentials, deregister services, cancel jobs, log uninstall activity. 3. onCustomEvent: Description: Runs when manually invoked from Rocketlane or an external system. Use cases: Handle custom workflows, sync data from external tools, trigger event-based actions. ``` -------------------------------- ### Rocketlane App Set-up Event Handlers Source: https://developer.rocketlane.com/v1.3/docs/back-end-capabilities Defines the structure for handling application setup events in Rocketlane. It includes parameters for the runtime context and event-specific arguments, and outlines the use cases for installation, uninstallation, and custom events. ```APIDOC Parameters: r: Rocketlane runtime context (includes logging, storage, HTTP clients). args: Event-specific data (installationId, user context, config values, etc.). Supported Set-up Events: 1. onAppInstall: Description: Runs automatically when your app is installed. Use cases: Initialize app configurations, register webhooks, create system resources, log installation. 2. onAppUninstall: Description: Runs automatically when a user removes your app. Use cases: Clean up storage/credentials, deregister services, cancel jobs, log uninstall activity. 3. onCustomEvent: Description: Runs when manually invoked from Rocketlane or an external system. Use cases: Handle custom workflows, sync data from external tools, trigger event-based actions. ``` -------------------------------- ### Rocketlane REST API Overview Source: https://developer.rocketlane.com/v1.3/docs/quick-start Provides an overview of the Rocketlane REST API, including links to developer tools, getting started guides, and core features like authentication, rate limiting, and pagination. ```APIDOC REST API: Developer tools: - Examples: https://developer.rocketlane.com/v1.3/docs/examples - API Explorer: https://developer.rocketlane.com/v1.3/docs/api-explorer Getting started: - Overview: https://developer.rocketlane.com/v1.3/docs/overview - Quick Start: https://developer.rocketlane.com/v1.3/docs/quick-start Features: - Authentication: https://developer.rocketlane.com/v1.3/docs/authentication - HTTP Status Codes: https://developer.rocketlane.com/v1.3/docs/http-status-codes - Rate limiting: https://developer.rocketlane.com/v1.3/docs/rate-limiting - Search: https://developer.rocketlane.com/v1.3/docs/search - Pagination: https://developer.rocketlane.com/v1.3/docs/pagination - Custom Fields: https://developer.rocketlane.com/v1.3/docs/custom-fields - Output options: https://developer.rocketlane.com/v1.3/docs/output-options ``` -------------------------------- ### Rocketlane Developer Tools and Guides Source: https://developer.rocketlane.com/v1.3/docs/search Access developer tools, examples, and guides for building integrations and applications with Rocketlane. This includes API Explorer, authentication, and rate limiting information. ```APIDOC ## REST API * [Developer tools](https://developer.rocketlane.com/v1.3/docs/examples) * [Examples](https://developer.rocketlane.com/v1.3/docs/examples) * [API Explorer](https://developer.rocketlane.com/v1.3/docs/api-explorer) * [Getting started](https://developer.rocketlane.com/v1.3/docs/overview) * [Overview](https://developer.rocketlane.com/v1.3/docs/overview) * [Quick Start](https://developer.rocketlane.com/v1.3/docs/quick-start) * [Features](https://developer.rocketlane.com/v1.3/docs/authentication) * [Authentication](https://developer.rocketlane.com/v1.3/docs/authentication) * [HTTP Status Codes](https://developer.rocketlane.com/v1.3/docs/http-status-codes) * [Rate limiting](https://developer.rocketlane.com/v1.3/docs/rate-limiting) * [Search](https://developer.rocketlane.com/v1.3/docs/search) * [Pagination](https://developer.rocketlane.com/v1.3/docs/pagination) * [Custom Fields](https://developer.rocketlane.com/v1.3/docs/custom-fields) * [Output options](https://developer.rocketlane.com/v1.3/docs/output-options) ``` -------------------------------- ### Rocketlane API Documentation Categories Source: https://developer.rocketlane.com/v1.3/docs/overview Outlines the three main categories of API documentation available: Guides for context and tutorials, API reference for objects and schemas, and Recipes for practical implementation examples. ```APIDOC API Documentation Structure: - Guides: API usage context, guides, and tutorials. - API reference: Comprehensive reference for objects, schemas, and endpoints. - Recipes: Practical manuals with syntax, parameters, and expected outcomes for specific API operations. ``` -------------------------------- ### Rocketlane REST API Documentation Source: https://developer.rocketlane.com/v1.3/docs/a-birds-eye-view-1 This section provides comprehensive documentation for the Rocketlane REST API, covering essential aspects for developers. It includes guides on getting started, authentication, HTTP status codes, rate limiting, search, pagination, custom fields, and output options. It also details webhook functionalities, including setup, event payloads, delivery, and examples. ```APIDOC REST API: Developer Tools: - Examples: https://developer.rocketlane.com/v1.3/docs/examples - API Explorer: https://developer.rocketlane.com/v1.3/docs/api-explorer Getting Started: - Overview: https://developer.rocketlane.com/v1.3/docs/overview - Quick Start: https://developer.rocketlane.com/v1.3/docs/quick-start Features: - Authentication: https://developer.rocketlane.com/v1.3/docs/authentication - HTTP Status Codes: https://developer.rocketlane.com/v1.3/docs/http-status-codes - Rate Limiting: https://developer.rocketlane.com/v1.3/docs/rate-limiting - Search: https://developer.rocketlane.com/v1.3/docs/search - Pagination: https://developer.rocketlane.com/v1.3/docs/pagination - Custom Fields: https://developer.rocketlane.com/v1.3/docs/custom-fields - Output Options: https://developer.rocketlane.com/v1.3/docs/output-options Webhooks: - Overview: https://developer.rocketlane.com/v1.3/docs/webhooks-overview - Setting up Webhooks: https://developer.rocketlane.com/v1.3/docs/setting-up-webhooks-in-rocketlane - Event Payload: https://developer.rocketlane.com/v1.3/docs/event-payload - Webhook Delivery: https://developer.rocketlane.com/v1.3/docs/webhook-delivery - Examples: https://developer.rocketlane.com/v1.3/docs/examples-1) ``` -------------------------------- ### Rocketlane API Reference - Output Options Source: https://developer.rocketlane.com/v1.3/docs/output-options This section provides an overview of the Rocketlane API, including links to developer tools, getting started guides, authentication, HTTP status codes, rate limiting, search, pagination, custom fields, and output options. It also covers webhooks and marketplace app development. ```APIDOC REST API: Developer tools: Examples: https://developer.rocketlane.com/v1.3/docs/examples API Explorer: https://developer.rocketlane.com/v1.3/docs/api-explorer Getting started: Overview: https://developer.rocketlane.com/v1.3/docs/overview Quick Start: https://developer.rocketlane.com/v1.3/docs/quick-start Features: Authentication: https://developer.rocketlane.com/v1.3/docs/authentication HTTP Status Codes: https://developer.rocketlane.com/v1.3/docs/http-status-codes Rate limiting: https://developer.rocketlane.com/v1.3/docs/rate-limiting Search: https://developer.rocketlane.com/v1.3/docs/search Pagination: https://developer.rocketlane.com/v1.3/docs/pagination Custom Fields: https://developer.rocketlane.com/v1.3/docs/custom-fields Output options: https://developer.rocketlane.com/v1.3/docs/output-options Webhooks: Overview: https://developer.rocketlane.com/v1.3/docs/webhooks-overview Setting up Webhooks in Rocketlane: https://developer.rocketlane.com/v1.3/docs/setting-up-webhooks-in-rocketlane Event Payload: https://developer.rocketlane.com/v1.3/docs/event-payload Webhook Delivery: https://developer.rocketlane.com/v1.3/docs/webhook-delivery Examples: https://developer.rocketlane.com/v1.3/docs/examples-1) Rocketlane Marketplace: Overview: https://developer.rocketlane.com/v1.3/docs/a-birds-eye-view-1 Rocketane app ecosystem: https://developer.rocketlane.com/v1.3/docs/rocketane-app-ecosystem App development process: https://developer.rocketlane.com/v1.3/docs/app-development-process Rocketlane CLI: https://developer.rocketlane.com/v1.3/docs/front-end-apps-copy-1 Apps: Configure the app index: https://developer.rocketlane.com/v1.3/docs/configure-the-app-index-2 Front-end capabilities: Include placeholders for app deployment: https://developer.rocketlane.com/v1.3/docs/include-placeholders-for-app App lifecycle methods: https://developer.rocketlane.com/v1.3/docs/app-lifecycle-methods-1 Data method: https://developer.rocketlane.com/v1.3/docs/data-method-1 Interface methods: https://developer.rocketlane.com/v1.3/docs/interface-method Events method: https://developer.rocketlane.com/v1.3/docs/events-method Back-end capabilities: App set-up events: https://developer.rocketlane.com/v1.3/docs/app-set-up-events-1 Key-value store: https://developer.rocketlane.com/v1.3/docs/key-value-store-2 Scheduler API: https://developer.rocketlane.com/v1.3/docs/scheduler-api-1 Scheduled actions: https://developer.rocketlane.com/v1.3/docs/scheduled-actions-2 Runtime Context Reference: https://developer.rocketlane.com/v1.3/docs/runtime-context-reference Examples: https://developer.rocketlane.com/v1.3/docs/examples-2 Rate limits and constraints: https://developer.rocketlane.com/v1.3/docs/rate-limits-and-constraints ``` -------------------------------- ### Rocketlane API - Base URL and Request Example Source: https://developer.rocketlane.com/v1.3/reference/get-all-phases Provides the base URL for the Rocketlane API and instructions on how to initiate a request. ```APIDOC Base URL: https://api.rocketlane.com/api/1.0/phases To start a request and view the response, click 'Try It!' in the API documentation interface. ``` -------------------------------- ### Example: Fetching User and Account Data Source: https://developer.rocketlane.com/v1.3/docs/data-method-1 An asynchronous JavaScript example demonstrating how to fetch both 'user' and 'account' data using `await client.data.get()` and log the retrieved information to the console. ```javascript async function getUserAndAccount() { const user = await client.data.get("user"); const account = await client.data.get("account"); console.log("Logged-in User:", user); console.log("Account Details:", account); } ``` -------------------------------- ### Rocketlane App Lifecycle Events Source: https://developer.rocketlane.com/v1.3/docs/app-lifecycle-methods-1 Defines the structure and parameters for `onAppInstall` and `onAppUninstall` lifecycle events in Rocketlane applications. `onAppInstall` is triggered upon app installation, useful for initialization and setup. `onAppUninstall` is triggered when an app is removed, intended for cleanup tasks. ```APIDOC onAppInstall: run: async (r, args) => { ... } Parameters: r: Rocketlane SDK runtime context args: installationId: unique ID for the installed app config: user-provided installation config values context: metadata like account ID, user ID, etc. onAppUninstall: run: (r, args) => { ... } Parameters: r: Rocketlane SDK runtime context args: installationId: the app instance being uninstalled context: metadata related to the uninstalling user/account ``` -------------------------------- ### Get All Fields API Response Examples Source: https://developer.rocketlane.com/v1.3/docs/custom-fields Provides example JSON responses for the 'Get all fields' API endpoint, illustrating how different custom field types like YES_OR_NO and SINGLE_CHOICE are represented. ```JSON { "fieldId":11, "fieldLabel":"Billable", "objectType":"TASK" } ``` ```JSON { "fieldId":12, "fieldLabel":"Priority", "objectType":"TASK", "fieldOptions":[ { "optionValue":1, "optionLabel":"Low" }, { "optionValue":2, "optionLabel":"Medium" }, { "optionValue":3, "optionLabel":"High" } ] } ``` -------------------------------- ### Get All Phases Source: https://developer.rocketlane.com/v1.3/reference/get-all-phases Retrieves all phases for a given project. This is a GET request that returns a list of phase objects, each containing details like phase name, start date, and end date. ```APIDOC GET /phases Description: Retrieves all phases associated with a project. Request: Method: GET URL: /phases Headers: Authorization: Bearer YOUR_API_KEY Response: Status Code: 200 OK Body: [ { "id": "phase_id_1", "name": "Phase 1", "startDate": "2023-01-01", "endDate": "2023-03-31", "status": "Completed" }, { "id": "phase_id_2", "name": "Phase 2", "startDate": "2023-04-01", "endDate": "2023-06-30", "status": "In Progress" } ] Error Responses: 401 Unauthorized: If the API key is invalid or missing. 404 Not Found: If the project or phases are not found. ``` -------------------------------- ### Rocketlane Webhook Setup Source: https://developer.rocketlane.com/v1.3/docs/setting-up-webhooks-in-rocketlane This section details the steps to create a new webhook in Rocketlane. It involves accessing the settings menu and initiating the webhook creation process. ```APIDOC APIDOC: title: Webhook Creation Steps description: Steps to create a new webhook in Rocketlane. steps: - step: Access Rocketlane Settings details: Log in to your Rocketlane account. Navigate to the left Nav bar, click on your Profile Icon, and then select 'Settings'. - step: Create a New Webhook details: Within the Settings menu, locate and click on 'Webhooks'. Subsequently, click the 'Add Webhook' button to begin the creation process. ``` -------------------------------- ### Create Project Request Source: https://developer.rocketlane.com/v1.3/docs/examples Demonstrates how to make a POST request to the Rocketlane API to create a new project. Includes the base URL, endpoint, required headers (accept, api-key, content-type), and the JSON payload for project details. ```curl curl --request POST \ --url \ --header 'accept: application/json' \ --header 'api-key: ' \ --header 'content-type: application/json' ``` ```JSON { "projectName":"Acme onboarding", "customer":{ "companyName":"Acme Inc" }, "owner":{ "emailId":"john.doe@rocketlane.com" } } ``` -------------------------------- ### Rocketlane Developer Tools Source: https://developer.rocketlane.com/v1.3/docs/include-placeholders-for-app Resources for developers, including examples and the API Explorer. ```APIDOC Developer Tools: Examples: https://developer.rocketlane.com/v1.3/docs/examples API Explorer: https://developer.rocketlane.com/v1.3/docs/api-explorer ``` -------------------------------- ### Rocketlane CLI Commands Source: https://developer.rocketlane.com/v1.3/docs/front-end-apps-copy-1 Reference for core Rocketlane CLI commands used for managing Rocketlane applications. This includes initializing new projects, starting a local development server, building the application for deployment, deploying the application to the Rocketlane Marketplace, and listing all associated applications. ```APIDOC rli init Initialize a new Rocketlane app project. Options: -t, --template : Select a template (default: "basic") -d, --dir : Specify the target directory For more options, run: rli init --help rli dev Start the local development server to preview your Rocketlane app. rli build Build the app for deployment. rli deploy Deploy your built app to the Rocketlane Marketplace. rli list View a list of all apps associated with your Rocketlane account. ``` -------------------------------- ### Create Project Request Source: https://developer.rocketlane.com/v1.3/docs Demonstrates how to make a POST request to the Rocketlane API to create a new project. Includes the base URL, endpoint, required headers (accept, api-key, content-type), and the JSON payload for project details. ```curl curl --request POST \ --url \ --header 'accept: application/json' \ --header 'api-key: ' \ --header 'content-type: application/json' ``` ```JSON { "projectName":"Acme onboarding", "customer":{ "companyName":"Acme Inc" }, "owner":{ "emailId":"john.doe@rocketlane.com" } } ``` -------------------------------- ### Create Project (POST) Source: https://developer.rocketlane.com/v1.3/docs/examples Demonstrates how to create a new project in Rocketlane using the REST API. This involves sending a POST request to the projects endpoint with the necessary project details. ```APIDOC POST /api/1.0/projects **Description:** Creates a new project. **Request Body:** ```json { "name": "New Project Name", "description": "Optional project description", "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD" } ``` **Response:** ```json { "id": "project_id", "name": "New Project Name", "description": "Optional project description", "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD", "createdAt": "timestamp", "updatedAt": "timestamp" } ``` **Example Usage:** ```bash curl -X POST https://api.rocketlane.com/api/1.0/projects \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Example Project", "startDate": "2023-10-27", "endDate": "2023-12-31" }' ``` ``` -------------------------------- ### Get All Spaces Source: https://developer.rocketlane.com/v1.3/reference/get-all-spaces Retrieves a list of all spaces available in the Rocketlane account. This is useful for getting an overview of all projects or work areas. ```APIDOC GET /spaces Description: Retrieves a list of all spaces. Request: Headers: Authorization: Bearer YOUR_API_KEY Response: Status Code: 200 OK Body: type: array items: type: object properties: id: { type: string, description: "Unique identifier for the space" } name: { type: string, description: "Name of the space" } createdAt: { type: string, format: date-time, description: "Timestamp when the space was created" } updatedAt: { type: string, format: date-time, description: "Timestamp when the space was last updated" } Example Response: [ { "id": "space_123", "name": "Project Alpha", "createdAt": "2023-10-27T10:00:00Z", "updatedAt": "2023-10-27T10:00:00Z" }, { "id": "space_456", "name": "Client Beta", "createdAt": "2023-10-26T15:30:00Z", "updatedAt": "2023-10-26T15:30:00Z" } ] ``` -------------------------------- ### Rocketlane Developer Tools Source: https://developer.rocketlane.com/v1.3/docs/front-end-capabilities Resources for developers, including examples and the API Explorer. ```APIDOC Developer Tools: Examples: https://developer.rocketlane.com/v1.3/docs/examples API Explorer: https://developer.rocketlane.com/v1.3/docs/api-explorer ``` -------------------------------- ### Rocketlane Marketplace App Development Source: https://developer.rocketlane.com/v1.3/docs/include-placeholders-for-app Guides for developing applications for the Rocketlane Marketplace, covering the app development process, front-end and back-end capabilities, and CLI tools. ```APIDOC Rocketlane Marketplace: Overview: https://developer.rocketlane.com/v1.3/docs/a-birds-eye-view-1 App Ecosystem: https://developer.rocketlane.com/v1.3/docs/rocketane-app-ecosystem App Development Process: https://developer.rocketlane.com/v1.3/docs/app-development-process Rocketlane CLI: https://developer.rocketlane.com/v1.3/docs/front-end-apps-copy-1 Configure App Index: https://developer.rocketlane.com/v1.3/docs/configure-the-app-index-2 Front-end Capabilities: Include Placeholders: https://developer.rocketlane.com/v1.3/docs/include-placeholders-for-app App Lifecycle Methods: https://developer.rocketlane.com/v1.3/docs/app-lifecycle-methods-1 Data Method: https://developer.rocketlane.com/v1.3/docs/data-method-1 Interface Methods: https://developer.rocketlane.com/v1.3/docs/interface-method Events Method: https://developer.rocketlane.com/v1.3/docs/events-method Back-end Capabilities: App Set-up Events: https://developer.rocketlane.com/v1.3/docs/app-set-up-events-1 Key-value Store: https://developer.rocketlane.com/v1.3/docs/key-value-store-2 Scheduler API: https://developer.rocketlane.com/v1.3/docs/scheduler-api-1 Scheduled Actions: https://developer.rocketlane.com/v1.3/docs/scheduled-actions-2 Runtime Context Reference: https://developer.rocketlane.com/v1.3/docs/runtime-context-reference Examples: https://developer.rocketlane.com/v1.3/docs/examples-2 Rate Limits and Constraints: https://developer.rocketlane.com/v1.3/docs/rate-limits-and-constraints ``` -------------------------------- ### Verify Rocketlane CLI Installation Source: https://developer.rocketlane.com/v1.3/docs/app-development-process Checks if the Rocketlane CLI has been installed correctly by displaying its version. This is a verification step after installation. ```bash rli --version ``` -------------------------------- ### Build the Rocketlane App Source: https://developer.rocketlane.com/v1.3/docs/app-development-process Compiles and prepares your Rocketlane application for deployment. This command bundles your front-end and serverless code. ```bash rli build ``` -------------------------------- ### Get All Projects Source: https://developer.rocketlane.com/v1.3/reference/get-all-projects Retrieves a list of all projects within the Rocketlane account. This endpoint is useful for getting an overview of all projects and their basic information. ```APIDOC GET /projects Description: Retrieves a list of all projects. Parameters: None Returns: An array of project objects, each containing details such as project ID, name, status, and dates. Example: GET https://api.rocketlane.com/v1/projects ``` -------------------------------- ### Get Task by ID Source: https://developer.rocketlane.com/v1.3/reference/get-task Fetches the details of a specific task using its unique ID. This is a GET request to the /tasks/{id} endpoint. ```APIDOC GET /tasks/{id} Description: Retrieves a specific task by its unique identifier. Parameters: - id (string, required): The unique identifier of the task to retrieve. Responses: 200 OK: Description: Task details retrieved successfully. Content: application/json: schema: type: object properties: id: { type: string, description: "Unique identifier of the task" } name: { type: string, description: "Name of the task" } status: { type: string, description: "Current status of the task" } dueDate: { type: string, format: date-time, description: "The due date of the task" } assignee: { type: object, description: "Information about the task assignee" } properties: id: { type: string } name: { type: string } createdAt: { type: string, format: date-time, description: "Timestamp when the task was created" } updatedAt: { type: string, format: date-time, description: "Timestamp when the task was last updated" } 404 Not Found: Description: Task with the specified ID not found. 401 Unauthorized: Description: Authentication failed or token is invalid. Example: GET https://api.rocketlane.com/v1.3/tasks/task_abc123 ``` -------------------------------- ### Create Project (POST) Source: https://developer.rocketlane.com/v1.3/docs Demonstrates how to create a new project in Rocketlane using the REST API. This involves sending a POST request to the projects endpoint with the necessary project details. ```APIDOC POST /api/1.0/projects **Description:** Creates a new project. **Request Body:** ```json { "name": "New Project Name", "description": "Optional project description", "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD" } ``` **Response:** ```json { "id": "project_id", "name": "New Project Name", "description": "Optional project description", "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD", "createdAt": "timestamp", "updatedAt": "timestamp" } ``` **Example Usage:** ```bash curl -X POST https://api.rocketlane.com/api/1.0/projects \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Example Project", "startDate": "2023-10-27", "endDate": "2023-12-31" }' ``` ``` -------------------------------- ### Get Space Document by ID Source: https://developer.rocketlane.com/v1.3/reference/get-space-document Fetches a document from a space using its unique ID. This is a GET request to the Rocketlane API. Ensure you have the correct space ID and document ID. ```APIDOC GET /spaces/{space_id}/documents/{document_id} Parameters: - space_id (string, required): The unique identifier of the space. - document_id (string, required): The unique identifier of the document to retrieve. Returns: - 200 OK: Returns the document object if found. - id (string): The document ID. - title (string): The title of the document. - content (string): The content of the document. - created_at (string): Timestamp of document creation. - updated_at (string): Timestamp of last document update. - 404 Not Found: If the space or document does not exist. - 401 Unauthorized: If authentication fails. Example: GET https://api.rocketlane.com/v1.3/spaces/space_abc123/documents/doc_xyz789 ``` -------------------------------- ### Rocketlane API - Get All Tasks Endpoint Source: https://developer.rocketlane.com/v1.3/reference/get-all-tasks Documentation for the 'Get all tasks' API endpoint in Rocketlane, including details on standard filtering, custom field filtering, and the use of AND/OR logical operators for advanced search queries. ```APIDOC GET /api/1.0/tasks **Description:** Retrieves a list of tasks with support for various filtering options. **Filtering Options:** - **Standard Filtering:** Allows filtering based on default task fields. - **Custom Field Filtering:** Enables filtering using custom fields associated with projects or tasks. The format for custom field filtering is `{type}.field.{field_id}.{operator}`, where `{type}` can be 'project' or 'task', `{field_id}` is the ID of the custom field, and `{operator}` specifies the comparison logic (e.g., `value`, `contains`, `greaterThan`, `isEmpty`). Refer to the 'Custom Field Filtering' section for detailed parameter mappings. - **Criteria Match:** Supports logical operators `AND` and `OR` to combine multiple filter conditions for complex searches. **Base URL:** https://api.rocketlane.com **Authentication:** Requires API keys via Authorization header. **Related Endpoints:** - `GET /api/1.0/fields`: To fetch `field_id` for custom fields. **Error Handling:** Refer to the [error handling](https://developer.rocketlane.com/docs/http-status-codes) section for details on potential issues and resolutions. ``` -------------------------------- ### Rocketlane Marketplace App Development Source: https://developer.rocketlane.com/v1.3/docs/a-birds-eye-view-1 This documentation outlines the process and capabilities for developing applications within the Rocketlane Marketplace. It covers the app ecosystem, development process, Rocketlane CLI, and configuration of app indexes. It details front-end capabilities like placeholders, lifecycle methods, data methods, interface methods, and events, as well as back-end capabilities including setup events, key-value stores, scheduler APIs, scheduled actions, and runtime context. ```APIDOC Rocketlane Marketplace: Overview: https://developer.rocketlane.com/v1.3/docs/a-birds-eye-view-1 Rocketlane App Ecosystem: https://developer.rocketlane.com/v1.3/docs/rocketane-app-ecosystem App Development Process: https://developer.rocketlane.com/v1.3/docs/app-development-process Rocketlane CLI: https://developer.rocketlane.com/v1.3/docs/front-end-apps-copy-1 Apps: Configure App Index: https://developer.rocketlane.com/v1.3/docs/configure-the-app-index-2 Front-end Capabilities: Include Placeholders for App Deployment: https://developer.rocketlane.com/v1.3/docs/include-placeholders-for-app App Lifecycle Methods: https://developer.rocketlane.com/v1.3/docs/app-lifecycle-methods-1 Data Method: https://developer.rocketlane.com/v1.3/docs/data-method-1 Interface Methods: https://developer.rocketlane.com/v1.3/docs/interface-method Events Method: https://developer.rocketlane.com/v1.3/docs/events-method Back-end Capabilities: App Set-up Events: https://developer.rocketlane.com/v1.3/docs/app-set-up-events-1 Key-Value Store: https://developer.rocketlane.com/v1.3/docs/key-value-store-2 Scheduler API: https://developer.rocketlane.com/v1.3/docs/scheduler-api-1 Scheduled Actions: https://developer.rocketlane.com/v1.3/docs/scheduled-actions-2 Runtime Context Reference: https://developer.rocketlane.com/v1.3/docs/runtime-context-reference Examples: https://developer.rocketlane.com/v1.3/docs/examples-2) Rate Limits and Constraints: https://developer.rocketlane.com/v1.3/docs/rate-limits-and-constraints ``` -------------------------------- ### Get All Space Documents - Criteria Match Source: https://developer.rocketlane.com/v1.3/reference/get-all-space-documents The 'Get all space documents' API supports advanced filtering using AND and OR conditions. Users can combine standard filters and custom field queries with these logical operators to construct complex search queries for more accurate results. ```APIDOC Endpoint: GET /api/1.0/space-documents Description: Retrieves a list of space documents with advanced filtering capabilities. Filtering: - Standard filtering and custom field filtering are supported. - Logical Operators: AND, OR can be used to combine multiple filter conditions. - Example: Combine a standard filter with a custom field filter using 'AND' for precise searching. Authentication: - Requires API keys. Log in via https://developer.rocketlane.com/login?redirect_uri=/reference/get-all-space-documents Base URL: - https://api.rocketlane.com Error Handling: - Refer to the error handling section: https://developer.rocketlane.com/docs/http-status-codes - Contact support at care@rocketlane.com for assistance. ``` -------------------------------- ### Rocketlane Webhooks Source: https://developer.rocketlane.com/v1.3/docs/include-placeholders-for-app Information on setting up and using webhooks in Rocketlane, including event payloads, delivery mechanisms, and examples. ```APIDOC Webhooks: Overview: https://developer.rocketlane.com/v1.3/docs/webhooks-overview Setting up Webhooks: https://developer.rocketlane.com/v1.3/docs/setting-up-webhooks-in-rocketlane Event Payload: https://developer.rocketlane.com/v1.3/docs/event-payload Webhook Delivery: https://developer.rocketlane.com/v1.3/docs/webhook-delivery Examples: https://developer.rocketlane.com/v1.3/docs/examples-1 ``` -------------------------------- ### Get All Space Documents Source: https://developer.rocketlane.com/v1.3/reference/get-all-space-documents Retrieves all documents associated with a specific space. This is useful for fetching all relevant information for a project space. ```APIDOC GET /spaces/{spaceId}/documents Description: Retrieves all documents for a given space. Parameters: - spaceId (string, required): The unique identifier of the space. Responses: 200 OK: description: A list of documents associated with the space. content: application/json: schema: type: array items: type: object properties: documentId (string): The unique identifier of the document. title (string): The title of the document. createdAt (string): The timestamp when the document was created. updatedAt (string): The timestamp when the document was last updated. content (string): The content of the document. 404 Not Found: description: The specified space was not found. 500 Internal Server Error: description: An unexpected error occurred on the server. ``` -------------------------------- ### Get Time Entry Source: https://developer.rocketlane.com/v1.3/reference/time-tracking-1 Retrieves a specific time entry by its unique identifier. This endpoint is part of the Rocketlane API v1.3. ```APIDOC GET /time-entries/{id} Retrieves a specific time entry. Parameters: - id (string, required): The unique identifier of the time entry to retrieve. Responses: - 200 OK: Returns the time entry object if found. Example: { "id": "64f7a1b2c3d4e5f6a7b8c9d0", "userId": "user123", "taskId": "task456", "projectId": "project789", "startTime": "2023-09-01T09:00:00Z", "endTime": "2023-09-01T11:00:00Z", "duration": 7200, "notes": "Worked on feature X" } - 404 Not Found: If the time entry with the specified ID does not exist. - 401 Unauthorized: If the API key is invalid or missing. ``` -------------------------------- ### Rocketlane Marketplace App Development Source: https://developer.rocketlane.com/v1.3/docs/front-end-capabilities Guides for developing applications for the Rocketlane Marketplace, covering the app development process, front-end and back-end capabilities, and CLI tools. ```APIDOC Rocketlane Marketplace: Overview: https://developer.rocketlane.com/v1.3/docs/a-birds-eye-view-1 App Ecosystem: https://developer.rocketlane.com/v1.3/docs/rocketane-app-ecosystem App Development Process: https://developer.rocketlane.com/v1.3/docs/app-development-process Rocketlane CLI: https://developer.rocketlane.com/v1.3/docs/front-end-apps-copy-1 Configure App Index: https://developer.rocketlane.com/v1.3/docs/configure-the-app-index-2 Front-end Capabilities: Include Placeholders: https://developer.rocketlane.com/v1.3/docs/include-placeholders-for-app App Lifecycle Methods: https://developer.rocketlane.com/v1.3/docs/app-lifecycle-methods-1 Data Method: https://developer.rocketlane.com/v1.3/docs/data-method-1 Interface Methods: https://developer.rocketlane.com/v1.3/docs/interface-method Events Method: https://developer.rocketlane.com/v1.3/docs/events-method Back-end Capabilities: App Set-up Events: https://developer.rocketlane.com/v1.3/docs/app-set-up-events-1 Key-value Store: https://developer.rocketlane.com/v1.3/docs/key-value-store-2 Scheduler API: https://developer.rocketlane.com/v1.3/docs/scheduler-api-1 Scheduled Actions: https://developer.rocketlane.com/v1.3/docs/scheduled-actions-2 Runtime Context Reference: https://developer.rocketlane.com/v1.3/docs/runtime-context-reference Examples: https://developer.rocketlane.com/v1.3/docs/examples-2 Rate Limits and Constraints: https://developer.rocketlane.com/v1.3/docs/rate-limits-and-constraints ``` -------------------------------- ### Get Time Entry Source: https://developer.rocketlane.com/v1.3/reference/get-time-entry Retrieves a specific time entry by its unique identifier. This endpoint is part of the Rocketlane API v1.3. ```APIDOC GET /time-entries/{id} Retrieves a specific time entry. Parameters: - id (string, required): The unique identifier of the time entry to retrieve. Responses: - 200 OK: Returns the time entry object if found. Example: { "id": "64f7a1b2c3d4e5f6a7b8c9d0", "userId": "user123", "taskId": "task456", "projectId": "project789", "startTime": "2023-09-01T09:00:00Z", "endTime": "2023-09-01T11:00:00Z", "duration": 7200, "notes": "Worked on feature X" } - 404 Not Found: If the time entry with the specified ID does not exist. - 401 Unauthorized: If the API key is invalid or missing. ``` -------------------------------- ### Remove Dependencies from Task - cURL Example Source: https://developer.rocketlane.com/v1.3/reference/remove-dependencies-from-task Example cURL request to remove dependencies from a specific task in Rocketlane. ```curl curl --request POST \ --url https://api.rocketlane.com/api/1.0/tasks/1/remove-dependencies \ --header 'accept: application/json' \ --header 'content-type: application/json' ``` -------------------------------- ### Rocketlane REST API Documentation Source: https://developer.rocketlane.com/v1.3/docs/examples-1 Provides comprehensive documentation for Rocketlane's REST API, covering authentication, HTTP status codes, rate limiting, search, pagination, custom fields, and output options. It serves as a central reference for interacting with the Rocketlane platform via its API. ```APIDOC REST API: - Developer tools: Examples, API Explorer - Getting started: Overview, Quick Start - Features: - Authentication - HTTP Status Codes - Rate limiting - Search - Pagination - Custom Fields - Output options - Webhooks: - Overview - Setting up Webhooks in Rocketlane - Event Payload - Webhook Delivery - Examples ```