A consistent and thoughtful naming convention is essential for ensuring clarity, ease of use, and efficient management of your projects, agents, and webhooks within the platform. Proper naming not only helps you and your team quickly identify and distinguish between different elements, but also supports scalability as your workspace grows.
In this article, we will guide you through the best practices for naming your resources, provide practical tips, and outline common pitfalls to avoid.
Detailed Steps and Recommendations
1. Use Clear, Descriptive Names
- Be Specific: Always choose names that clearly describe the purpose or role of the item. For example, naming a project “Customer Portal Redesign 2024” is more informative than “Project1”.
- Include Key Details: When relevant, add context such as environment (e.g., “Staging”), business unit, or product version.
2. Maintain Consistency
- Follow a Pattern: Decide on a naming structure and apply it throughout. Example:
[ProductName] – [Function/Purpose] – [Environment]- Example for projects: “BillingService – IntegrationTests – Staging”
- Example for agents: “SEO Article Generator – Weekly”
- Team Agreement: Before starting, align with your team on naming standards to prevent confusion.
3. Avoid Special Characters and Spaces
- Use Hyphens or Underscores: Replace spaces with hyphens or underscores (for example, use “webhook_payment_success” rather than “Webhook Payment Success”).
- Restrict Special Characters: Especially for webhooks, avoid using characters like
! @ # $ % ^ & * ( ) to prevent technical issues.
4. Use Lowercase or PascalCase/TitleCase
- Lowercase for Simplicity: For machine-facing resources (like webhooks), use only lowercase letters and hyphens:
order-updated-production. - PascalCase/TitleCase for Clarity: For user-facing names, capitalize each word for readability:
Marketing Insights Agent.
5. Add Date or Version Information (When Needed)
- Time Context: If you plan to run multiple versions, include the date or version for easy identification (e.g., “Changelog Agent v2 – Q2 2024”).
6. Document Your Naming Standards
- Central Reference: Maintain a shared document or a wiki page listing naming conventions for your team.
- Update as Needed: Adjust conventions as your organizational needs evolve.
Examples
- Project:
- Good:
MobileApp – Release2024 – Production - Not Recommended:
App1
- Agent:
- Good:
Changelog Generator – Weekly - Not Recommended:
AgentA
- Webhook:
- Good:
payment-success-notification - Not Recommended:
Webhook 1
Conclusion
Taking the time to establish and follow strong naming conventions pays off in easier collaboration, faster onboarding of team members, and efficient navigation of your workspace. By applying the best practices outlined above, you’ll ensure your projects, agents, and webhooks are well-organized, intuitive, and scalable.
If you need additional guidance or have questions about implementing these standards, feel free to consult our support team or review our detailed documentation.
