Core Concepts

Before diving into Captain Data’s API, it’s essential to understand the core concepts that define how workflows, jobs, and accounts function. A strong grasp of these fundamentals will help you seamlessly build and integrate automation into your application.

​

Overview of Core Entities

​

Key Relationships

1. Users and Accounts: Each User can own one or more Accounts.
2. Workflows and Runs: A Workflow generates Runs (called “Jobs”) when executed.
3. Runs (Jobs) and Webhooks: Webhooks are triggered by run completion, sending key data for further actions.

​

Users

​

What is a User?

A User in Captain Data corresponds to a user in your SaaS platform.

• Users can have one or more Accounts.
• They are essential for authentication and interacting with Actions and Workflows.

​

User Roles

1. Owner:
   • Full platform access.
   • Can manage users, accounts, billing, and subscriptions.
2. User:
   • Limited access without billing or subscription management rights.
3. External User:
   • No platform access.
   • Used for linking shared accounts via API.

Note: When creating users via API, they default to the External role.

​

Managing Users

• User licenses are included in your plan (e.g., 5 users in the Scale plan).
• Additional user licenses can be purchased for 49€ per user by contacting sales.

​

Securing Users

At Captain Data, user security is paramount. Every user is assigned a unique IP address to enhance security. Learn more about user management and security here.

​

Accounts

​

What is an Account?

An Account represents an external integration, such as LinkedIn or HubSpot, that Actions and Workflows depend on.

• An Account belongs to a single User.
• Accounts authenticate workflows with third-party APIs.

​

LinkedIn Specifics

• Captain Data applies smart limitations to prevent LinkedIn account restrictions.
• Supported LinkedIn licenses include Sales Navigator, Premium, and Recruiter Lite.
• Renting LinkedIn accounts is available to help you avoid the hassle of managing or warming up accounts.

Learn More:

• Smart Limitations for LinkedIn Accounts
• Supported LinkedIn Licenses
• When to Sync Users vs. Use Rented LinkedIn Accounts

​

Workflows

​

What is a Workflow?

A Workflow is a sequence of automated steps or actions, similar to an API route performing a specific task.

• Workflows are tied to Run (Jobs), which execute them.
• Each workflow is identified by a unique workflow_uid.

​

Runs (Jobs)

​

What is a Job?

A Job represents a single execution of a workflow.

• Jobs are linked to a User and a Workflow.
• Each job generates a unique job_uid for tracking and retrieving results.

​

Webhooks & Polling

​

Webhooks

Webhooks notify your application when a job completes, whether successful or not.

• They send crucial data like the job_uid and execution details.
• Use webhooks to retrieve results or handle errors efficiently.

Learn more about webhooks here.

​

Polling

Polling allows you to retrieve results as soon as they are ready, even before a job is complete. Read more about polling here.

​

Learn More

Dive deeper into Captain Data’s capabilities with these guides:

• Adding & Managing Users
• Workflow Launch Logic & Configuration for Developers