Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: Dataset schema specification
sidebar_position: 3
description: Learn how to define and present your dataset schema in an user-friendly output UI.
slug: /actors/development/actor-definition/dataset-schema
sidebar_label: Dataset schema
---

# Dataset schema specification

**Learn how to define and present your dataset schema in an user-friendly output UI.**

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: Input schema specification
title: Actor input schema specification
sidebar_position: 2
description: Learn how to define and validate a schema for your Actor's input with code examples. Provide an autogenerated input UI for your Actor's users.
slug: /actors/development/actor-definition/input-schema/specification/v1
toc_max_heading_level: 5
sidebar_label: Input schema specification
---

# Actor input schema specification

**Learn how to define and validate a schema for your Actor's input with code examples. Provide an autogenerated input UI for your Actor's users.**

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Learn how to define and present your key-value store schema to orga
slug: /actors/development/actor-definition/key-value-store-schema
---

# Key-value Store Schema Specification

**Learn how to define and present your key-value store schema to organize records into collections.**

---
Expand Down
5 changes: 2 additions & 3 deletions sources/platform/actors/development/automated_tests.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Automated tests
title: Automated tests for Actors
description: Learn how to automate ongoing testing and make sure your Actors perform over time. See code examples for configuring the Actor Testing Actor.
slug: /actors/development/automated-tests
sidebar_position: 9
sidebar_label: Automated tests
---

**Learn how to automate ongoing testing and make sure your Actors perform over time. See code examples for configuring the Actor Testing Actor.**
Expand All @@ -12,8 +13,6 @@ import TabItem from '@theme/TabItem';

---

# Automated tests for Actors

Automated testing is crucial for maintaining the reliability and performance of your Actors over time. This guide will help you set up automated tests using the [Actor Testing Actor](https://apify.com/pocesar/actor-testing).

## Set up automated tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Learn how to maintain an Actor's state to prevent data loss during
slug: /actors/development/builds-and-runs/state-persistence
---

# State persistence

**Learn how to maintain an Actor's state to prevent data loss during unexpected restarts. Includes code examples for handling server migrations.**

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ slug: /actors/development/deployment/continuous-integration
sidebar_position: 2
---

# Continuous integration for Actors

**Learn how to set up automated builds, deploys, and testing for your Actors.**

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: Environment variables
title: Actor environment variables
description: Learn how to provide your Actor with context that determines its behavior through a plethora of pre-defined environment variables offered by the Apify SDK.
slug: /actors/development/programming-interface/environment-variables
sidebar_position: 3
sidebar_label: Environment variables
---

# Actor environment variables

**Learn how to provide your Actor with context that determines its behavior through a plethora of pre-defined environment variables set by the Apify platform.**

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: System events
title: System events in Apify Actors
description: Learn about system events sent to your Actor and how to benefit from them.
slug: /actors/development/programming-interface/system-events
sidebar_position: 4
sidebar_label: System events
---

# System events in Apify Actors

**Learn about system events sent to your Actor and how to benefit from them.**

import Tabs from '@theme/Tabs';
Expand Down
2 changes: 0 additions & 2 deletions sources/platform/actors/running/usage_and_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ sidebar_position: 2
slug: /actors/running/usage-and-resources
---

# Usage and resources

**Learn about your Actors' memory and processing power requirements, their relationship with Docker resources, minimum requirements for different use cases and its impact on the cost.**

---
Expand Down
22 changes: 10 additions & 12 deletions sources/platform/collaboration/list_of_permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,17 @@ sidebar_position: 12.2
slug: /collaboration/list-of-permissions
---

# List of permissions

**Learn about the access rights you can grant to other users. See a list of all access options for Apify resources such as Actors, actActoror runs/tasks and storage.**

---

This document contains all the access options that can be granted to resources on the Apify platform.

## Actors {#actors}
## Actors

Click [here](../actors/index.mdx) to learn about Apify Actors.
To learn about Apify Actors, check out the [documentation](../actors/index.mdx).

### Actor {#actor}
### Actor

| Permission | Description |
|----------------------|------------------------------------------------------------|
Expand All @@ -27,7 +25,7 @@ Click [here](../actors/index.mdx) to learn about Apify Actors.
| View runs | View a list of Actor runs and their details. |
| Manage access rights | Manage Actor access rights. |

### Actor task {#actor-task}
### Actor task

| Permission | Description |
|----------------------|------------------------------------------------------------|
Expand All @@ -38,11 +36,11 @@ Click [here](../actors/index.mdx) to learn about Apify Actors.

To learn about Actor tasks, see the [documentation](../actors/running/tasks.md).

## Storage {#storage}
## Storage

For more information about Storage, see its [documentation](../storage/index.md).

### Dataset {#dataset}
### Dataset

| Permission | Description |
|----------------------|-----------------------------------------------------------------|
Expand All @@ -52,7 +50,7 @@ For more information about Storage, see its [documentation](../storage/index.md)

To learn about dataset storage, see its [documentation](../storage/dataset.md).

### Key-value-store {#key-value-store}
### Key-value-store

| Permission | Description |
|----------------------|---------------------------------------------------------------------------------------------------|
Expand All @@ -62,7 +60,7 @@ To learn about dataset storage, see its [documentation](../storage/dataset.md).

To learn about key-value stores, see the [documentation](../storage/key_value_store.md).

### Request queue {#request-queue}
### Request queue

| Permission | Description |
|----------------------|------------------------------------------------------------------------------------------------|
Expand All @@ -72,15 +70,15 @@ To learn about key-value stores, see the [documentation](../storage/key_value_st

To learn about request queue storage, see the [documentation](../storage/request_queue.md).

## Proxy {#proxy}
## Proxy

| Permission | Description |
|------------|---------------------------|
| Proxy | Allow to use Apify Proxy. |

To learn about Apify Proxy, see its [documentation](../proxy/index.md).

## User permissions {#user-permissions}
## User permissions

Permissions that can be granted to members of organizations. To learn about the organization account, see its [documentation](./organization_account/index.md).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: How to use
title: Using the organization account
description: Learn to use and manage your organization account using the Apify Console or API. View the organizations you are in and manage your memberships.
sidebar_position: 2
slug: /collaboration/organization-account/how-to-use
sidebar_label: How to use
---

# Using the organization account

**Learn to use and manage your organization account using the Apify Console or API. View the organizations you are in and manage your memberships.**

---
Expand All @@ -17,7 +16,7 @@ While you can't manage an organization account via [API](/api/v2), you can still

**[See our video tutorial](https://www.youtube.com/watch?v=BIL6HqtnvKk) on organization accounts.**

## In the Apify Console {#in-the-apify-console}
## In the Apify Console

You can switch into **Organization account** view using the account button in the top-left corner.

Expand All @@ -29,19 +28,19 @@ The resources you can access and account details you can edit will depend on you

> When switching between accounts, beware which account you start an Actor run in. If you accidentally start an organization's Actor run in your personal account, the run will be billed to your account (and vice versa).

### Manage your organizations {#manage-your-organizations}
### Manage your organizations

You can view and manage the organizations you are a member of from the **Organizations** tab on your [account page](https://console.apify.com/account#/myorganization).

If you want to leave an organization you own, you must first transfer ownership to someone else.

![My organizations](../images/organizations/my-organizations.png)

### Transfer ownership {#transfer-ownership}
### Transfer ownership

The organization, its Actors, and its integrations will keep running as they are. The original owner will either leave the organization or become a member with permissions defined by the new owner. Only the new owner will have complete access to the organization.

## Via API {#via-api}
## Via API

While you cannot manage an organization account's settings and members via API, you can access its Actor and task runs, webhooks, schedules, and storages just as you would with any other account.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ sidebar_position: 12.1
slug: /collaboration/organization-account
---

# Organization account

**Create a specialized account for your organization to encourage collaboration and manage permissions. Convert an existing account, or create one from scratch.**

---
Expand All @@ -22,19 +20,19 @@ You can set up an organization in two ways.

> Prefer video to reading? [See our video tutorial](https://www.youtube.com/watch?v=BIL6HqtnvKk) for organization accounts.

## Availability and pricing {#availability-and-pricing}
## Availability and pricing

The organization account is available on all our plans. [Visit our pricing page](https://apify.com/pricing) for more information.

## Create a new organization {#create-a-new-organization}
## Create a new organization

You can create a new organization by clicking the **Create new organization** button under the **Organizations** tab in your [account](https://console.apify.com/account#/myorganizations). If you want the organization to have a separate email address (used for notifications), enter it here. Otherwise, leave the **email** field empty and the owner's email will be used for notifications.

![Create a new organization](../images/organizations/create-new-org.png)

**You can own up to 5 and be a member of as many organizations as you need.**

## Convert an existing account {#convert-an-existing-account}
## Convert an existing account

> **When you convert an existing user account into an organization,**
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ sidebar_position: 1
slug: /collaboration/organization-account/setup
---

# Setup

**Configure your organization account by inviting new members and assigning their roles. Manage team members' access permissions to the organization's resources.**

---
Expand All @@ -27,13 +25,13 @@ In the **Account** tab's **Security** section, you can set security requirements

**[See our video tutorial](https://www.youtube.com/watch?v=BIL6HqtnvKk) on organization accounts.**

## Add users to your organization {#add-users-to-your-organization}
## Add users to your organization

You can add members to your organization in the **Members** tab. You can use their **User ID**, **username**, or **email**. When adding a member to the organization, you must assign them a **Role** so their permissions are known right away.

![Organization members](../images/organizations/members.png)

## Define roles and permissions {#define-roles-and-permissions}
## Define roles and permissions

Roles allow you to define permissions to your organization's resources by group. Every new organization comes with three pre-defined roles, which you can customize or remove.

Expand Down
4 changes: 1 addition & 3 deletions sources/platform/integrations/actors/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title: Actor-to-Actor integration
title: What are Actor integrations?
description: Learn how to integrate with other Actors and tasks.
sidebar_label: Actor-to-Actor
slug: /integrations/actors
---

# What are Actor integrations?

**Learn how to integrate with other Actors and tasks.**

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ sidebar_position: 2
slug: /integrations/actors/integrating-actors-via-api
---

# Integrating Actors via API

**Learn how to integrate with other Actors and tasks using the Apify API.**

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ sidebar_position: 1
slug: /integrations/actors/integration-ready-actors
---

# Integration-ready Actors

**Learn how to create Actors that are ready to be integrated with other Actors and tasks.**

---
Expand Down
2 changes: 0 additions & 2 deletions sources/platform/integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ slug: /integrations
import Card from '@site/src/components/Card';
import CardGrid from '@site/src/components/CardGrid';

# Integrations

**Learn how to integrate the Apify platform with other services, your systems, data pipelines, and other web automation workflows.**

---
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/programming/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The Personal API tokens are different from your own Personal API tokens mentione

On the other hand the Organization API tokens (only visible if you are the owner or have Manage access tokens permission) have full permissions and are not tied to a specific member of the organization.

## API tokens with limited permissions {#limited-permissions}
## API tokens with limited permissions

By default, tokens can access all data in your account. If that is not desirable, you can choose to limit the permissions of your token, so that it can only access data needed for the particular use case. We call these tokens **scoped**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ slug: /integrations/make

[Make](https://www.make.com/) _(formerly Integromat)_ allows you to create scenarios where you can integrate various services (modules) to automate and centralize jobs. Apify has its own module you can use to run Apify Actors, get notified about run statuses, and receive Actor results directly in your Make scenario.

## Connect Apify to Make {#connect-apify-to-make}
## Connect Apify to Make

To use the Apify integration on Make, you will need:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To use the Apify integration for Slack, you will need:
- An [Apify account](https://console.apify.com/).
- A Slack account (and workspace).

## Step 1: Set up the integration for Slack {#step-one}
## Step 1: Set up the integration for Slack

You can find all integrations on an Actor's or task's **Integrations** tab. For example, you can try using the [Google Shopping Scraper](https://console.apify.com/actors/aLTexEuCetoJNL9bL).

Expand All @@ -38,11 +38,11 @@ Then, head back to your task to finish the setup. Select what type of events you

Once you are done, click the **Save** button.

## Step 2: Give the Apify integration a trial run! {#step-two}
## Step 2: Give the Apify integration a trial run

Click the **Start** button and head to the Slack channel you selected to see your first Apify integration notifications.

## Step 3: Start your run directly from Slack {#step-three}
## Step 3: Start your run directly from Slack

You can now run the same Actor or task directly from Slack by typing `/apify call [Actor or task ID]` into the Slack message box.

Expand Down
Loading