raycast / extensions

Everything you need to extend Raycast.
https://developers.raycast.com
MIT License
5.41k stars 3.1k forks source link

feat: flexible twenty raycast integration #15413

Open Nabhag8848 opened 5 days ago

Nabhag8848 commented 5 days ago

🔥 Twenty Raycast Integration

Twenty simplifies CRM management, empowering businesses to enhance productivity and drive growth. With this Raycast integration, record creation across standard and custom objects is now at your fingertips, making your workflow effortless and efficient. Experience how easy it is to use this Raycast for seamless record creation!

${\textcolor{#39FF14}{\textbf{🤝 Create records instantly across Standard and Custom Objects!}}}$

Command Descriptions

Create Object Record

With Create Object Record command, effortlessly create records in any standard or custom object. Search command press Enter to see active objects, then press CMD + Enter to unveil a form that fills in your record seamlessly into the CRM table — making CRM magic happen!


Getting Started

Get your API Keys from twenty developer settings , navigate to Raycast Command settings or try to access command which will open up view to provide your API key.

Twenty Api Token View

if you are selfhost user navigate to <self-host-url>/settings/developers, once you have your key, go to Raycast Command Settings to provide your selfhost api url and API key. If you don't provide selfhost url, Integration will assume https://api.twenty.com as your instance.

Raycast Settings

User Guide

To use the integration, search for the Create Object Record command, which will display all your active standard and custom objects currently in your twentyCRM. Its very flexible - if you create new objects or deactivate existing ones, this will automatically reflect those changes.

https://github.com/user-attachments/assets/fca0f71d-3c04-43ad-afb4-4e5b0a9d4d13

When you deactivate any standard or custom object, it will no longer appear, ensuring you only see the information and objects you want to access. This makes the integration extensible and enhances your productivity.

https://github.com/user-attachments/assets/f357b91b-dd2e-4043-af8c-9328235c0aa8

If you create new custom objects, they will appear, allowing you to quickly create your records instantly from Raycast.

https://github.com/user-attachments/assets/f0d8fa96-468b-42e4-a11c-a9e4a47ce412

To create a record for any object, select your target object and press ENTER. This will open a form that matches the exact table schema you created in your CRM, following any validations it suggests to successfully create your record by pressing CMD + ENTER. Records cannot be created with an empty first column (such as Name, Title, etc.).

https://github.com/user-attachments/assets/6f8d7127-63a6-4113-ac6a-5ea3003c5f0c

Similar to creation of standard object record you can create custom objects record

https://github.com/user-attachments/assets/098e120c-ac58-4f41-9560-2782c798d6bd

It's much more flexible—similar to objects, if you deactivate any fields, they will no longer appear in your object schema during record creation.

https://github.com/user-attachments/assets/2686c7c0-dfde-4445-93be-17d10cf22d60

No worries! If you add or update any fields in your standard objects, they will automatically appear in your object schema form in Raycast, looking closely you will see, if you add a select field with a default value provided some icon, it will display exactly what you’ve set when creation.

https://github.com/user-attachments/assets/697da72b-1ca2-4493-b61c-d393b77b34f6

🧑‍💻 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
  3. Install Dependency (npm install) & follow getting started guide for api key.
  4. Commit your Changes (git commit -m 'feat: adds some amazing feature')
  5. Push to the Branch (git push origin feat/AmazingFeature)
  6. Open a Pull Request

💬 Connect With Me

| **Name** | Nabhag Motivaras | |:--------------------|:-------------------| | **Twitter** | [@NabhagMotivaras](https://x.com/NabhagMotivaras) |

Support my work

If you love my work and would like to support me, consider becoming a GitHub sponsor

Roadmap

Checklist

raycastbot commented 5 days ago

Thank you for your first contribution! :tada:

🔔 @chrisdadev13 @xmok you might want to have a look.

You can use this guide to learn how to check out the Pull Request locally in order to test it.

You can expect an initial review within five business days.

Nabhag8848 commented 5 days ago

will open again, see you folks in slack, have several questions and concerns around.

xmok commented 2 days ago

@Nabhag8848 I get what you're trying to do but there are way too many breaking changes and you're doing a lot of stuff incorrectly e.g. removing the author and contributor from package.json. The removal of hooks also makes us lose out on lots of Raycast Util goodies 😋.

I'd suggest we phase this out so it's easier to review and approve your changes as we need to follow Raycast Store best practices. You can ping me on Slack if you need any help.

EDIT: Just saw your message in Slack. Please ignore.

Nabhag8848 commented 2 days ago

thanks, we are looking to change authorship, lemme dm you on slack.