Partners - Plane Documentation

Working with the API

Core Resources

HR

Workforce

Benefits

Payments

Payroll

Documents

Time

Labor

Legal

curl https://api.plane.com/v1/workers \
  -u YOUR_PARTNER_API_KEY: \
  -H "Plane-Workspace: wsp_8rT2mVq5xNp3Kd"

Every API key belongs to one workspace. When your workspace is a partner workspace, its keys also manage the workspaces you created for your clients: they create workspaces, list them, and act inside a managed workspace by naming it with the Plane-Workspace header. Requests to a workspace your partner does not manage are rejected.

curl https://api.plane.com/v1/workers \
  -u YOUR_PARTNER_API_KEY: \
  -H "Plane-Workspace: wsp_8rT2mVq5xNp3Kd"

Webhooks

Events in a managed workspace are delivered to that workspace’s webhook endpoints and to your partner workspace’s endpoints. Configure endpoints once in your partner workspace and use each event’s workspace field to tell which managed workspace it came from. Each message is also tagged with the source workspace ID as a channel, so an endpoint can filter to one managed workspace.

⌘I

​Webhooks

Webhooks