Step 1: Endpoint Setup

The first step in creating your API is setting up the endpoint. This defines the basic structure and URL for your API.

What is an Endpoint?

An endpoint is a specific URL where your API can receive requests. It's like a mailbox address where data gets delivered.

Example: If you create an endpoint named contact-form, your API will be available at:

https://your-api-domain.com/api/contact-form

Endpoint Configuration

Endpoint Name

The endpoint name becomes part of your API URL and must follow these rules:

Naming Rules

• ✅ Use lowercase letters only
• ✅ Use hyphens to separate words
• ✅ Keep it descriptive but concise
• ✅ Make it unique across your account

Good Examples

user-feedback
contact-form
product-inquiry
event-registration
support-ticket

Bad Examples

User Feedback          ❌ Contains spaces and capitals
contact_form           ❌ Uses underscores
my-api                 ❌ Too generic
contact-form-v2        ❌ Avoid version numbers in names

Description

Write a clear description that explains:

• What the API does

• What data it collects

• Who should use it

Good Examples Help

"Collects user feedback and ratings for products and services"
"Handles contact form submissions from the website"
"Manages event registration with attendee information"

Bad Examples Here

"API for stuff"                    ❌ Too vague
"Collects data"                    ❌ Not specific enough
"User input form"                  ❌ Doesn't explain purpose

Step-by-Step Setup

1. Enter Endpoint Name

1. In the Endpoint Name field, type your endpoint name
2. Follow the naming rules above
3. The system will show you the preview URL

2. Add Description

1. In the Description field, write a clear description
2. Explain what your API does
3. Keep it concise but informative

3. Create Endpoint

1. Click the "Create" button
2. Wait for confirmation
3. You'll see a success message when ready

4. Continue to Next Step

1. Click "Continue to Field Configuration"
2. You'll move to Step 2 of the Flow Builder

Endpoint URL Structure

Your endpoint will be available at:

https://your-api-domain.com/api/{endpoint-name}

Example URLs

Endpoint Name: contact-form
URL: https://your-api-domain.com/api/contact-form

Endpoint Name: user-feedback
URL: https://your-api-domain.com/api/user-feedback

Endpoint Name: event-registration
URL: https://your-api-domain.com/api/event-registration

Best Practices

Planning Your Endpoint

1. Think about your data: What information do you need to collect?
2. Consider your users: Who will be sending data to this API?
3. Plan for the future: Will you need similar endpoints later?
4. Keep it simple: Start with one clear purpose per endpoint

Naming Strategy

• Be consistent: Use the same naming pattern across all your endpoints

• Be descriptive: The name should clearly indicate the endpoint's purpose

• Be concise: Keep names short but meaningful

• Avoid versions: Don't include version numbers in endpoint names

Description Guidelines

• Be specific: Explain exactly what the API does

• Include context: Mention where or how it will be used

• Use clear language: Write for your team members to understand

• Keep it updated: Update descriptions if the API purpose changes

Common Endpoint Types

Contact Forms

Name: contact-form
Description: "Handles general contact form submissions from website visitors"

User Feedback

Name: user-feedback
Description: "Collects user feedback and ratings for products and services"

Event Registration

Name: event-registration
Description: "Manages event registration with attendee information and preferences"

Support Tickets

Name: support-ticket
Description: "Creates support tickets with issue details and user information"

Newsletter Signup

Name: newsletter-signup
Description: "Handles newsletter subscription requests with user preferences"

Product Inquiry

Name: product-inquiry
Description: "Collects product information requests and customer details"

Troubleshooting

"Endpoint name already exists"

• Choose a different name

• Add a descriptive suffix (e.g., contact-form-v2)

• Check if you already created this endpoint

"Invalid endpoint name"

• Remove spaces and special characters

• Use only lowercase letters and hyphens

• Keep the name under 50 characters

"Description too long"

• Keep descriptions under 200 characters

• Focus on the most important information

• Remove unnecessary words

Next Steps

Once you've created your endpoint:

1. ✅ Endpoint is ready - Your API URL is generated
2. ➡️ Move to Step 2 - Configure the fields for your API
3. 📝 Add fields - Define what data your API accepts

Continue to Step 2: Field Configuration to define the data fields for your API.