-
Notifications
You must be signed in to change notification settings - Fork 232
docs: add integration development skill reference #2987
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -253,4 +253,6 @@ Trigger Apify Actors from workflow automation platforms (n8n, Make, and Zapier), | |
|
|
||
| If you're building a service or platform and want your users to be able to connect it with Apify, [create a new integration](/integrations/integrate). The page walks through both routes - building an integration-ready Actor that other Apify users can plug into their workflows, or connecting your service to Apify externally via the API. | ||
|
|
||
| If your team uses an AI coding agent, the [apify-integration-development](https://github.com/apify/agent-skills/tree/main/skills/apify-integration-development) skill guides it through building an official Apify integration for your product. See [Integrate with Apify](/integrations/integrate) for details. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note: Should we instead link to the " how to install the skill page? https://github.com/apify/agent-skills/tree/main#installation |
||
|
|
||
| If your tool isn't listed above, you can also browse [Apify Store](https://apify.com/store) for community-built integration Actors like [MongoDB Import](https://apify.com/drobnikj/mongodb-import) or [MySQL Insert](https://apify.com/petr_cermak/mysql-insert). | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,10 @@ slug: /integrations/integrate | |
|
|
||
| If you are building a service and your users could benefit from integrating with Apify or vice versa, we would love to hear from you! Contact us at [integrations@apify.com](mailto:integrations@apify.com) to discuss potential collaboration. We are always looking for ways to make the Apify platform more useful and powerful for users. | ||
|
|
||
| :::tip Build with an AI coding agent | ||
| If your team uses an AI coding agent such as Cursor, Claude Code, GitHub Copilot, or OpenCode, install the [apify-integration-development](https://github.com/apify/agent-skills/tree/main/skills/apify-integration-development) skill. It guides your agent through designing and building an official Apify integration for your product, with reference files for every integration shape Apify supports. See [Build with the integration skill](#build-with-the-integration-skill) below. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note: the agent list does not match what the skill repo supports — its README documents Claude Code, Cursor, Windsurf, Codex and Gemini CLI via a |
||
| ::: | ||
|
|
||
| ## Why integrate with Apify | ||
|
|
||
| Apify is the leading platform for web scraping, AI agents, and automation tools. By integrating Apify into your platform, you enable users to incorporate real-time, structured data from the web with zero scraping infrastructure on your side. | ||
|
|
@@ -53,6 +57,17 @@ An alternative way is to let your users manage the connection directly on your s | |
|
|
||
|  | ||
|
|
||
| ### Build with the integration skill | ||
|
|
||
| The [`apify-integration-development`](https://github.com/apify/agent-skills/tree/main/skills/apify-integration-development) skill guides your AI coding agent through designing and building an official Apify integration. It covers four integration shapes - read the reference file that matches your product: | ||
|
|
||
| - Workflow automation platforms - Zapier, n8n, Make, Pipedream, Activepieces. | ||
| - AI agent plugins - coding-agent bundles for Cursor, Claude Code, and GitHub Copilot, or harness plugins for OpenClaw and Hermes. | ||
| - AI framework packages - LangChain, LlamaIndex, Haystack, Vercel AI SDK. | ||
| - Application integrations - a backend service or product feature calling Actors via `apify-client` or REST. | ||
|
|
||
| The skill enforces the cross-cutting rules every Apify integration needs: asynchronous run flow with bounded polling, cost controls (`maxTotalChargeUsd`, `maxItems`), attribution headers, OAuth2 and API-token authentication, and webhooks over polling. Once you publish your integration, contact [integrations@apify.com](mailto:integrations@apify.com) so the Apify team can review and validate it before it reaches users. | ||
|
|
||
| ### Authentication methods | ||
|
|
||
| Apify supports two main authentication methods for secure API access. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: the paragraph directly above already links
/integrations/integrate, so the closing "See Integrate with Apify for details" is a second link to the same page one line later — dropping it keeps the pointer to the skill as the only new thing here.