<aside> đź’ˇ Interested in building a Playbook Plugin?

Make sure you’ve read Welcome to Playbook’s Beta Developer Program and Why should I join the Playbook Beta Developer Program? for an overview of our Developer Program.

In this Quickstart guide, we’ll walk you through how to register, develop, and publish a Playbook Plugin:

</aside>

Join the Playbook Developer Program

First, register with Playbook to join our Developer Program:

  1. Sign up for a Playbook account.
  2. Email [email protected] to register for the developer program, or contact us via our Discord channel
  3. Wait for our approval (usually takes about a few business hours).

<aside> ✔️ Checkpoint: At the end of this step, navigate to https://www.playbook.com/account and verify that you can now see the Plugins and Developer Profile tabs.

</aside>

Register a Sandbox Plugin

Next, register your Plugin to be able to develop against your Sandbox:

  1. Navigate to the Plugins tab of https://www.playbook.com/account and hit Create a new Plugin.

    Untitled

  2. Fill in the details about your Plugin (you can edit this prior to publishing).

    1. The Invocation URL is where Playbook will notify you of Plugin Invocations.
    2. Set the cost per invocation (see How much can my plugin make?)

  3. Navigate to the Apps page of your playbook at https://www.playbook.com/<YOUR_PLAYBOOK>/new-app.

  4. Click on your Sandbox Plugin and install it in your playbook.

<aside> ✔️ Checkpoint: If you navigate to any asset in your playbook, you should see a button to invoke your Plugin:

Untitled

</aside>