devrev · starlightknown · May 24, 2024 · May 23, 2024
@@ -28,13 +28,13 @@ A connection uses a keyring object to provide authentication, access token refre
 
 ## Event source
 
-[Event sources](/snap-in-development/references/event-sources) collect events from webhooks, emails, and timer-based API calls. Events can also be manually published. DevRev supports the ingestion of webhooks from any source. Each event source is assigned to a dev org.
+[Event sources](/snapin-development/references/event-sources) collect events from webhooks, emails, and timer-based API calls. Events can also be manually published. DevRev supports the ingestion of webhooks from any source. Each event source is assigned to a dev org.
 
 For example, if you want to collect webhook events from an organization's GitHub, create an event source which in turn gives us a URL to subscribe to on GitHub. Webhook events published to this URL are available from this event source.
 
 ## Function
 
-The framework for executing code provided by users is [functions](/snap-in-development/references/functions). Currently, Javascript/TypeScript can be taken as input from the user and deployed as a function.
+The framework for executing code provided by users is [functions](/snapin-development/references/functions). Currently, Javascript/TypeScript can be taken as input from the user and deployed as a function.
 
 Connection values can be passed to a function at runtime, enabling it to execute API calls to DevRev and to external systems such as GitHub, Slack, Bitbucket, and Discord.
 
@@ -44,17 +44,17 @@ Snap-ins can be configured to enable and disable features, based on custom input
 
 ## Commands
 
-A user can trigger [commands](/snap-in-development/references/commands) on different surfaces based on some parameters. Once a command is executed, a function is triggered.
+A user can trigger [commands](/snapin-development/references/commands) on different surfaces based on some parameters. Once a command is executed, a function is triggered.
 
 A developer can develop commands to be included in a snap-in Version along with associated functions. These commands are installed when the snap-in is installed.
 
 As part of the snap-in, commands have access to keyrings, global variables, and event sources.
 
 ## Hooks
 
-[Hooks](/snap-in-development/references/hooks) enable developers to invoke functions when various events in the lifecycle of a snap-in occur. Hooks can be used to perform various actions based on the event such as validating the snap-in inputs and keyrings when the configuration is updated, registering event-sources and webhooks in external platforms when snap-in is activated, or setting custom fields to be used by the snap-in.
+[Hooks](/snapin-development/references/hooks) enable developers to invoke functions when various events in the lifecycle of a snap-in occur. Hooks can be used to perform various actions based on the event such as validating the snap-in inputs and keyrings when the configuration is updated, registering event-sources and webhooks in external platforms when snap-in is activated, or setting custom fields to be used by the snap-in.
 
-Detailed documentation on hooks can be found in the [hooks reference](/snap-in-development/references/hooks).
+Detailed documentation on hooks can be found in the [hooks reference](/snapin-development/references/hooks).
 
 ## States
 
@@ -76,7 +76,7 @@ The following diagram illustrates the transitions between different states.
 
 ## Snap-kit
 
-[Snap-kit](/snap-in-development/references/snapkit) defines UI customization components. It's defined in the snap-in package and used to display developer-defined components. A snap-kit component can display data to a user or collect input for triggering a function.
+[Snap-kit](/snapin-development/references/snapkit) defines UI customization components. It's defined in the snap-in package and used to display developer-defined components. A snap-kit component can display data to a user or collect input for triggering a function.
 
 ## Marketplace
 

@@ -10,7 +10,7 @@ A brief [tutorial](/api-reference/getting-started) shows you how to access the A
 
 Specifications covering the supported APIs are based on OpenAPI Specification 3.0. You can download the specs to use an OpenAPI 3.0-compliant tool to perform a variety of actions, including rendering them in UI and generating SDKs. Two [versions](/about/versioning) of the DevRev API are available: [public](/public) and [beta](/beta) (early access). Use the drop-down menu in the upper-left corner of this site to switch between versions.
 
-To take action based on events from the DevRev platform, [webhooks](/guides/getting-started-with-webhooks) are also supported.
+To take action based on events from the DevRev platform, [webhooks](/guides/webhooks) are also supported.
 <Cards>
     <Card
     title="Public"
@@ -27,7 +27,7 @@ To take action based on events from the DevRev platform, [webhooks](/guides/gett
 
 ## 🧩 Snap-ins
 
-Numerous snap-ins are available on the DevRev [Marketplace](https://devrev.ai/marketplace). The [snap-in framework](/snap-in-development/concepts) is available for you to create your own snap-ins for automation of DevRev workflows or integration with other system.
+Numerous snap-ins are available on the DevRev [Marketplace](https://devrev.ai/marketplace). The [snap-in framework](/snapin-development/concepts) is available for you to create your own snap-ins for automation of DevRev workflows or integration with other system.
 
 ## 💻 SDKs
 

@@ -34,11 +34,11 @@ The publishing process commences by initiating a marketplace submission, which e
 
 ## Get started
 
-To get started with publishing marketplace item, you need DevRev CLI. Refer to [DevRev CLI Cheatsheet](/snap-in-development/references/install-dev-rev-cli) for more information.
+To get started with publishing marketplace item, you need DevRev CLI. Refer to [DevRev CLI Cheatsheet](/snapin-development/references/install-dev-rev-cli) for more information.
 
 ### Create a snap-in
 
-To proceed with making a submission in marketplace, you need a snap-in for which you are creating this submission. If you are new to snap-ins, [follow the development and deployment guide](/snap-in-development/tutorials/overview) to create your first snap-in.
+To proceed with making a submission in marketplace, you need a snap-in for which you are creating this submission. If you are new to snap-ins, [follow the development and deployment guide](/snapin-development/tutorials/overview) to create your first snap-in.
 
 ## Create marketplace listing
 

@@ -312,7 +312,7 @@ The `--force` flag deletes the snap-in even if the `deactivate` hook fails. If t
 
 ## Snap-in context
 
-The CLI persists in the context of the CLI in a [snap-in context](#snap-in-context). The context is used to store the following information per snap-in package slug:
+The CLI persists in the context of the CLI in a snap-in context. The context is used to store the following information per snap-in package slug:
 
 1. The ID of the snap-in package owning the slug.
 2. The ID of the last created/upgraded snap-in version, if any.

@@ -1,6 +1,6 @@
 Using functions, you can provide custom code and link it to your event sources, automations, or snap-kit actions. Functions are written in JavaScript and can be used to transform events, send notifications, or perform any other custom logic including network calls.
 
-In order to create a snap-in version, functions must be defined as shown in the [code samples](/snap-in-development/code-samples). Functions are packaged and provided as an artifact at the time of snap-in version creation and then used to deploy functions to snap-in versions. An artifact may contain multiple function definitions. The artifact is a zip file containing the following files:
+In order to create a snap-in version, functions must be defined as shown in the [code samples](/snapin-development/code-samples). Functions are packaged and provided as an artifact at the time of snap-in version creation and then used to deploy functions to snap-in versions. An artifact may contain multiple function definitions. The artifact is a zip file containing the following files:
 
 ```bash
 /
@@ -26,4 +26,4 @@ functions:
 - `name`: It is the function name that should match the corresponding function name in the folder.
 - `description`: It describes the function.
 
-Refer to the [function invocation](/snap-in-development/references/function-invocation) for details about the exact payload of the function.
+Refer to the [function invocation](/snapin-development/references/function-invocation) for details about the exact payload of the function.
@@ -18,9 +18,9 @@ hooks:
     function: update-resource
 ```
 
-The above definition would register the hooks and invoke the provided functions alongside each hook. The functions can be defined in the manifest and provided in the code as explained in the [functions reference](/snap-in-development/references/functions).
+The above definition would register the hooks and invoke the provided functions alongside each hook. The functions can be defined in the manifest and provided in the code as explained in the [functions reference](/snapin-development/references/functions).
 
-For the event schema received by the function invocation, refer to the [function invocation reference](/snap-in-development/references/function-invocation).
+For the event schema received by the function invocation, refer to the [function invocation reference](/snapin-development/references/function-invocation).
 
 The event name is the identifier for the hook. The event name can be used to identify the hook that's being invoked. The identifiers are defined in the summary table below.
 

@@ -61,7 +61,7 @@ Keyrings defined in the manifest can be provided in the snap-in configuration sc
 
 Organization keyrings are common to the organization, while user keyrings are set per user. User keyrings are optional, so the developer must correctly handle cases where the keyring isn't found.
 
-To view the supported connection types, see [Keyrings](/snap-in-development/references/keyrings).
+To view the supported connection types, see [Keyrings](/snapin-development/references/keyrings).
 
 ## Developer keyrings
 
@@ -143,7 +143,7 @@ Event sources can be categorized as "organization" level and "user" level. Event
 
 ```
 
-Refer to [Event sources](/snap-in-development/references/event-sources) for a checklist of supported event sources and their corresponding event types.
+Refer to [Event sources](/snapin-development/references/event-sources) for a checklist of supported event sources and their corresponding event types.
 
 Refer to the webhook event-request example for a list of supported webhooks:
 

@@ -40,7 +40,7 @@ connections:
       - devrev-github-oauth
 ```
 
-Service that stores these secrets and has the business logic to refresh tokens, when applicable. Here is the list of currently supported connection types - [Connections](/snap-in-development/references/keyrings)
+Service that stores these secrets and has the business logic to refresh tokens, when applicable. Here is the list of currently supported connection types - [Connections](/snapin-development/references/keyrings)
 
 ## Developer connections
 
@@ -106,7 +106,7 @@ Event sources are specified in the manifest with the following syntax:
         type: <enum specifying what type of the source should be created>
 ```
 
-Here is the [list of supported event sources](/snap-in-development/references/event-sources).
+Here is the [list of supported event sources](/snapin-development/references/event-sources).
 
 Example:
 

@@ -29,13 +29,13 @@ A connection uses a keyring object to provide authentication, access token refre
 
 ## Event source
 
-[Event sources](/snap-in-development/references/event-sources) collect events from webhooks, emails, and timer-based API calls. Events can also be manually published. DevRev supports the ingestion of webhooks from any source. Each event source is assigned to a dev org.
+[Event sources](/snapin-development/references/event-sources) collect events from webhooks, emails, and timer-based API calls. Events can also be manually published. DevRev supports the ingestion of webhooks from any source. Each event source is assigned to a dev org.
 
 For example, if you want to collect webhook events from an organization's GitHub, create an event source that gives you a URL to subscribe to on GitHub. Webhook events published to this URL are available from this event source.
 
 ## Function
 
-The framework for executing code provided by users is [functions](/snap-in-development/references/functions). Currently, Javascript/TypeScript can be taken as input from the user and deployed as a function.
+The framework for executing code provided by users is [functions](/snapin-development/references/functions). Currently, Javascript/TypeScript can be taken as input from the user and deployed as a function.
 
 Connection values can be passed to a function at runtime, enabling it to execute API calls to DevRev and external systems such as GitHub, Slack, Bitbucket, and Discord.
 
@@ -45,17 +45,17 @@ Snap-ins can be configured to enable and disable features, based on custom input
 
 ## Commands
 
-A user can trigger [commands](/snap-in-development/references/commands) on different surfaces based on some parameters. Once a command is executed, a function is triggered.
+A user can trigger [commands](/snapin-development/references/commands) on different surfaces based on some parameters. Once a command is executed, a function is triggered.
 
 A developer can develop commands to be included in a snap-in version along with associated functions. These commands are installed when the snap-in is installed.
 
 As part of the snap-in, commands have access to keyrings, global variables, and event sources.
 
 ## Hooks
 
-[Hooks](/snap-in-development/references/hooks) enable developers to invoke functions when various events in the lifecycle of a snap-in occur. Hooks can be used to perform various actions based on the event such as validating the snap-in inputs and keyrings when the configuration is updated, registering event sources and webhooks in external platforms when snap-in is activated, or setting custom fields to be used by the snap-in.
+[Hooks](/snapin-development/references/hooks) enable developers to invoke functions when various events in the lifecycle of a snap-in occur. Hooks can be used to perform various actions based on the event such as validating the snap-in inputs and keyrings when the configuration is updated, registering event sources and webhooks in external platforms when snap-in is activated, or setting custom fields to be used by the snap-in.
 
-Detailed documentation on hooks can be found in the [hooks reference](/snap-in-development/references/hooks).
+Detailed documentation on hooks can be found in the [hooks reference](/snapin-development/references/hooks).
 
 ## States
 
@@ -81,7 +81,7 @@ Snap-in resources are user-level objects like keyrings, event sources, and input
 
 ## Snap-kit
 
-[Snap-kit](/snap-in-development/references/snapkit) defines UI customization components. It's defined in the snap-in package and used to display developer-defined components. A snap-kit component can display data to a user or collect input for triggering a function.
+[Snap-kit](/snapin-development/references/snapkit) defines UI customization components. It's defined in the snap-in package and used to display developer-defined components. A snap-kit component can display data to a user or collect input for triggering a function.
 
 ## Marketplace
 

@@ -8,7 +8,7 @@ Snap-ins are collections of objects that extend DevRev's core platform value. Th
 
 ### Installation guide
 
-- Install [DevRev CLI](/snap-in-development/references/install-dev-rev-cli)
+- Install [DevRev CLI](/snapin-development/references/cli-install)
 - Install [jq](https://stedolan.github.io/jq)
 
 ### Log in to DevRev for authentication
@@ -57,24 +57,24 @@ devrev-snaps-typescript-template/
 
 The command creates a folder `devrev-snaps-typescript-template`. This contains a `manifest.yaml` file and a `code` folder.
 
-- `manifest` file defines the resources to be created on the DevRev platform. For detailed information on the various components of a manifest file, see [Snap-in Manifest](/snap-in-development/references/snap-in-manifest).
+- `manifest` file defines the resources to be created on the DevRev platform. For detailed information on the various components of a manifest file, see [Snap-in Manifest](/snapin-development/references/manifest).
 - `code` folder consists of sample starter code for snap-ins. For detailed information on how to get started, see [starter example repo](https://github.com/devrev/snap-in-examples/tree/main/1-starter/code#readme).
 
 ### Creating a snap-in package
 
-To create a [snap-in package](/snap-in-development/concepts), run the following command:
+To create a [snap-in package](/snapin-development/concepts), run the following command:
 
 ```bash
 devrev snap_in_package create-one --slug my-first-snap-in | jq .
 ```
 <Callout intent="note">
 1. The slug is globally unique. If the slug provided is already taken, a conflict error occurs. This can be resolved by provided a different slug.
-2. On successful creation, the CLI automatically stores the package ID in its context corresponding to the slug. For more information, refer to the [Snap-in Context](/snap-in-development/references/install-dev-rev-cli).
+2. On successful creation, the CLI automatically stores the package ID in its context corresponding to the slug. For more information, refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context).
 </Callout>
 
 ### Creating a snap-in version
 
-To create a [snap-in version](/snap-in-development/concepts), run the following command:
+To create a [snap-in version](/snapin-development/references/cli#snap-in-version), run the following command:
 
 ```bash
 devrev snap_in_version create-one --path ./devrev-snaps-typescript-template | jq .
@@ -90,7 +90,7 @@ Output:
 }
 ```
 <Callout intent="info">
- The CLI automatically stores the version ID in its context. Refer to the [Snap-in Context](/snap-in-development/references/install-dev-rev-cli) section for more information.
+ The CLI automatically stores the version ID in its context. Refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context) section for more information.
 </Callout>
 
 In a package that's not published to the marketplace, you can have only one snap-in version. If you have an existing snap-in version in the package, the following error message is shown:
@@ -130,7 +130,7 @@ To install the snap-in, you must be a member of the **Admins** group in the de
 <br />
 
 <Callout intent="info">
-The CLI automatically stores the snap-in ID in its context. Refer to the [Snap-in Context](/snap-in-development/references/install-dev-rev-cli) section for more information.
+The CLI automatically stores the snap-in ID in its context. Refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context) section for more information.
 </Callout>
 
 ### Configuring the snap-in
@@ -172,6 +172,6 @@ devrev snap_in_version upgrade --path ./
 
 The above expects the manifest file to be present in the current directory by the name `manifest.yaml` and the code to be present in the `code` directory.
 
-Refer to [upgrade command](/snap-in-development/upgrade-snap-ins) for more information.
+Refer to [upgrade command](/snapin-development/upgrade-snap-ins) for more information.
 
 </Steps>