๐Ÿ“ Step 1: Login and Access Workflows

  1. Go to worqhat.app
  2. Login to your organization account.
  3. Navigate to โ€œWorkflowsโ€ from the dashboard or sidebar.

โš™๏ธ Step 2: Create a New Workflow

  1. Click on โ€œCreate Workflowโ€.
  2. Youโ€™ll be redirected to the Workflows Page, where all your workflows are listed.
  3. Click on โ€œCreate Newโ€ โ€” this opens a modal asking for the workflow name.

โšก Step 3: Choose a Trigger

Triggers

A Trigger is how your workflow is started. Select one of the following:

โœ… Supported Trigger Types:

  • URL-based: Start the workflow by making an HTTP request to a provided URL.
  • File-based: Similar to URL-based, but allows uploading a file with the request.
  • Time-based: Works like a cron job. Trigger it at regular intervals (seconds, minutes, hours).
  • Email-based: Send an email to a unique address to trigger the workflow.
  • WhatsApp-based: A message sent to a specific WhatsApp number will start the workflow.

โœ๏ธ Step 4: Describe Your Workflow (Optional)

AiAissist Youโ€™ll now see an optional modal to describe your workflow, which helps WorqHatโ€™s AI assistant generate the first draft:

๐Ÿง  AI Description Fields:

  • Given: e.g., โ€œan Image, a Text Document, etc.โ€
  • I want to: e.g., โ€œdetect faces, analyze sentiment, etc.โ€
  • And return: e.g., โ€œthe detected objects, the analysis results, etc.โ€

You can also add:

  • Additional Instructions (Optional)
  • Reference Image (Optional)

๐ŸŽจ Step 5: Canvas โ€” Build Your Workflow

workflow canvas Whether you used the AI or not, youโ€™ll be taken to the Workflow Canvas:

  • Use the right-hand sidebar to drag and drop nodes.
  • Connect nodes in the desired flow.
  • Click on a node to configure it and use variables via the {} button in node settings.

๐Ÿ”ง Step 6: Configure Docs and API Access

  1. Click on the โ€œDocsโ€ button (next to Analytics).
  2. WorqHat will provide:
    • Suggested API Key
    • Your workflow endpoint
  3. Click on โ€œGenerate Documentโ€ for code examples in:
    • Python
    • Node.js
    • cURL
    • and moreโ€ฆ

โœ… Step 7: Activate and Save Your Workflow

  • Switch the status from ๐Ÿ”ด Red (Inactive) to ๐ŸŸข Green (Active).
  • Click โ€œSave Changesโ€ to preserve your work.

๐Ÿงช Step 8: Test Your Workflow

Use the built-in โ€œTest Flowโ€ button to test your workflow โ€” no website or Postman required.


๐Ÿ“ฆ Variables and Storage

You can define variables in your workflow to store and reuse information between steps โ€” just like memory cells in a program.

These are extremely helpful when:

  • You want to pass values (like user input or file content) from one node to another.
  • You need conditional branching or custom logic.
  • You want to reduce hardcoding and make your workflows dynamic.

๐Ÿ”ง How to Access Variables

Use the {} button inside any nodeโ€™s input field to reference a variable.

๐Ÿ’ก Example: Setting a Limit

Suppose youโ€™re checking whether a submitted number exceeds a limit of 50.

  1. Variable Node
    Set a variable called limit with value: 50

  2. Condition Node
    Use an expression like: inputNumber > limit

  3. Message Node (If True)
    Message: The value exceeds the limit of limit.

This keeps your workflow clean, reusable, and easily adjustable later.


๐Ÿ“Š Analytics

  • Click on โ€œAnalyticsโ€ to see logs and performance metrics of your workflow.

๐Ÿง  Summary

FeatureDescription
Drag-n-Drop CanvasBuild workflows visually
Trigger TypesURL, File, Email, WhatsApp, Time
API + DocsAuto-generate code and API keys
Manual & AI BuildSupports both methods
Variable SupportDynamic inputs/outputs
Built-in TesterNo Postman needed

๐Ÿ“ Example Use Cases

  • Lead Generation: Receive WhatsApp leads and analyze sentiment.
  • File Parser: Upload Excel sheets and extract structured data.
  • Email Classifier: Send emails to a workflow that tags spam or priority.

๐Ÿ™‹ Need Help?

Check out our Docs Page or reach out to our community for support.


// Example: Trigger a URL-based Workflow using fetch
fetch("https://api.worqhat.com/flows/trigger/FlowId", {
  method: "POST",
  headers: {
    Authorization: "Bearer Token",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    text: "Your input text here",
  }),
})
  .then((response) => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error("Error:", error);
  });