Use Craft’s API to Build With Zapier

Use Craft's API to build apps on Zapier. Fetch your documents, sync content, and create custom tools powered by your Craft data.

Enabling the API for Documents

First, you have to enable the API in order for Craft to setup an API endpoint for your documents. Then, you use the API endpoint URL to connect to the server from Zapier.

Step 1

Open the “Imagine” tab

Step 2

Click “Add Your First API Connection”

Step 3

Configure your API connection with a name.

Step 4

Click “Add Document” to select which documents this API connection has access to.

Step 5

The API URL that will be used to interact with your document is now displayed at the top

Step 6

Click the “Download AI Bundle” button. This will download a folder containing the API documentation and the content of your doc.

Using the API in a Zapier Prompt

Once the API is enabled for your Craft docs, you can now focus on writing a prompt that Zapier will use to generate your project.

In order for Zapier to see how to use the API and understand the structure of your document, you attach the AI bundle to your prompt. This bundle is a markdown document that contains the current content of your Craft doc as well as the API documentation.

Step 1

Gehen Sie zu Zapier und erstellen Sie einen neuen Zap. Klicken Sie auf den Aktionsschritt, suchen Sie nach „Webhooks by Zapier“ und wählen Sie unter den Aktionsereignissen „Benutzerdefinierte Anfrage“ aus.

Step 2

Konfigurieren Sie den Webhook mit der Craft-API-Endpunkt-URL, legen Sie die Methode auf GET fest und fügen Sie die erforderlichen Header aus dem heruntergeladenen AI-Bundle hinzu. Testen Sie den Schritt, um die Verbindung zu überprüfen.

Step 3

Fügen Sie zusätzliche Aktionsschritte hinzu, um die API-Antwort zu verarbeiten und Verbindungen zu anderen Apps herzustellen. Sie können mehrstufige Zaps erstellen, die Ihre Craft-Dokumente automatisch lesen und aktualisieren.